Close a conversation

POST

/conversations/{conversationId}/close

const url = 'https://api.siteassist.io/v2/conversations/123e4567-e89b-12d3-a456-426614174000/close';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"closeReason":"Issue resolved"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url https://api.siteassist.io/v2/conversations/123e4567-e89b-12d3-a456-426614174000/close \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "closeReason": "Issue resolved" }'

Close an open conversation for the authenticated visitor in the current project. Optionally include a close reason.

Authorizations

bearerAuth

Parameters

Path Parameters

conversationId

required

The unique identifier of the conversation to close

string format: uuid

Example

123e4567-e89b-12d3-a456-426614174000

Request Body

application/json

object

closeReason

Optional reason for closing the conversation

string

<= 256 characters

Example

Issue resolved

Responses

200

Successfully closed the conversation

application/json

Confirmation that the conversation was closed or was already closed.

object

success

required

boolean

message

string

Example

{
  "success": true,
  "message": "Conversation closed successfully."
}

400

Bad Request - The request body or parameters are invalid

application/json

object

error

required

object

message

required

Human-readable error message describing what went wrong

string

code

Machine-readable error code for programmatic handling

string

details

Additional error details and context

object

key

additional properties

nullable

Example

{
  "error": {
    "message": "Invalid request body. Content is required.",
    "code": "INVALID_REQUEST_BODY",
    "details": {
      "field": "content"
    }
  }
}

401

Unauthorized - Authentication token is missing or invalid

application/json

object

error

required

object

message

required

Human-readable error message describing what went wrong

string

code

Machine-readable error code for programmatic handling

string

details

Additional error details and context

object

key

additional properties

nullable

Example

{
  "error": {
    "message": "Authentication required",
    "code": "UNAUTHORIZED"
  }
}

402

Payment Required - A higher pricing plan is required to access the resource

application/json

object

error

required

object

message

required

Human-readable error message describing what went wrong

string

code

Machine-readable error code for programmatic handling

string

details

Additional error details and context

object

key

additional properties

nullable

Example

{
  "error": {
    "message": "A higher pricing plan is required to access this feature",
    "code": "PAYMENT_REQUIRED",
    "details": {
      "currentPlan": "free",
      "requiredPlan": "pro",
      "feature": "advanced_ai_models"
    }
  }
}

403

Forbidden - Access denied to the requested resource

application/json

object

error

required

object

message

required

Human-readable error message describing what went wrong

string

code

Machine-readable error code for programmatic handling

string

details

Additional error details and context

object

key

additional properties

nullable

Example

{
  "error": {
    "message": "Access denied to this conversation",
    "code": "FORBIDDEN"
  }
}

404

Not Found - The requested resource was not found

application/json

object

error

required

object

message

required

Human-readable error message describing what went wrong

string

code

Machine-readable error code for programmatic handling

string

details

Additional error details and context

object

key

additional properties

nullable

Example

{
  "error": {
    "message": "Conversation not found!",
    "code": "CONVERSATION_NOT_FOUND",
    "details": {
      "conversationId": "123e4567-e89b-12d3-a456-426614174000"
    }
  }
}

409

Conflict - The request could not be completed due to a conflict

application/json

object

error

required

object

message

required

Human-readable error message describing what went wrong

string

code

Machine-readable error code for programmatic handling

string

details

Additional error details and context

object

key

additional properties

nullable

Example

{
  "error": {
    "message": "Resource already exists",
    "code": "CONFLICT",
    "details": {
      "resource": "conversation",
      "conflictingField": "id"
    }
  }
}

422

Unprocessable Entity - The request was well-formed but contains semantic errors

application/json

object

error

required

object

message

required

Human-readable error message describing what went wrong

string

code

Machine-readable error code for programmatic handling

string

details

Additional error details and context

object

key

additional properties

nullable

Example

{
  "error": {
    "message": "Validation failed",
    "code": "VALIDATION_ERROR",
    "details": {
      "field": "content",
      "reason": "Content exceeds maximum length of 10000 characters"
    }
  }
}

429

Too Many Requests - Rate limit exceeded or quota reached

application/json

object

error

required

object

message

required

Human-readable error message describing what went wrong

string

code

Machine-readable error code for programmatic handling

string

details

Additional error details and context

object

key

additional properties

nullable

Example

{
  "error": {
    "message": "Rate limit exceeded. Please try again later.",
    "code": "RATE_LIMIT_EXCEEDED",
    "details": {
      "retryAfter": 60
    }
  }
}

500

Internal Server Error - An unexpected error occurred

application/json

object

error

required

object

message

required

Human-readable error message describing what went wrong

string

code

Machine-readable error code for programmatic handling

string

details

Additional error details and context

object

key

additional properties

nullable

Example

{
  "error": {
    "message": "An internal server error occurred",
    "code": "INTERNAL_SERVER_ERROR"
  }
}

502

Bad Gateway - The server received an invalid response from an upstream server

application/json

object

error

required

object

message

required

Human-readable error message describing what went wrong

string

code

Machine-readable error code for programmatic handling

string

details

Additional error details and context

object

key

additional properties

nullable

Example

{
  "error": {
    "message": "Service temporarily unavailable",
    "code": "BAD_GATEWAY",
    "details": {
      "service": "ai_model_service"
    }
  }
}

503

Service Unavailable - The server is temporarily unable to handle the request

application/json

object

error

required

object

message

required

Human-readable error message describing what went wrong

string

code

Machine-readable error code for programmatic handling

string

details

Additional error details and context

object

key

additional properties

nullable

Example

{
  "error": {
    "message": "Service temporarily unavailable",
    "code": "SERVICE_UNAVAILABLE",
    "details": {
      "retryAfter": 30
    }
  }
}