Skip to navigation

Update live agent integration

View as Markdown

Changes the fields you send and returns the full updated document.

Send only the fields you want to change, plus version with the num from your last read and a change_description. This is a JSON merge-patch: a field you leave out keeps its stored value, and every list or map you send replaces the stored one whole. The id goes in the URL; if you also send id in the body it must match.

Authentication

AuthorizationBearer

JWT bearer token authentication. Include the Configuration API key in the Authorization header as ‘Bearer <token>’.

Path parameters

idstringRequired

The id of the live agent integration, as returned when it was created or listed.

Request

This endpoint expects an object.
versionobjectRequired
Document version. On update, send back the num from your last read.
channelobjectOptional
Hands off by routing the user's messages to a channel where agents respond.
apiobjectOptional
Hands off through a live agent provider's API, such as Vayusphere or BeyondTrust.
urlobjectOptional
Hands off by directing the user to a URL that connects them to an agent.
agent_brokerobjectOptional
Hands off by brokering the chat to a live agent provider, such as Amazon Connect, ServiceNow, Genesys or Salesforce.
file_ticket_enabledbooleanOptional
If true, a ticket is automatically filed for the user whenever they request a live agent.
ticket_receipt_traitsobjectOptional
Additional settings for the ticket filed when a user requests a live agent.

Response

The updated live agent integration, at its new version
idstringOptionalRead-only
Unique identifier of the handoff configuration, assigned by the server.
namestringOptionalformat: "^([a-z]+)[a-z0-9_]*$"
Unique key used to refer to this handoff. Must start with a lowercase letter and contain only lowercase letters, digits and underscores. Cannot be changed after creation.
channelobjectOptional
Hands off by routing the user's messages to a channel where agents respond.
apiobjectOptional
Hands off through a live agent provider's API, such as Vayusphere or BeyondTrust.
urlobjectOptional
Hands off by directing the user to a URL that connects them to an agent.
agent_brokerobjectOptional
Hands off by brokering the chat to a live agent provider, such as Amazon Connect, ServiceNow, Genesys or Salesforce.
file_ticket_enabledbooleanOptional
If true, a ticket is automatically filed for the user whenever they request a live agent.
ticket_receipt_traitsobjectOptional
Additional settings for the ticket filed when a user requests a live agent.
updated_timedatetimeOptionalRead-only
When the configuration was last updated.
updated_bystringOptionalRead-only
Who last updated the configuration.
versionobjectOptional
Document version. On update, send back the num from your last read.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
409
Conflict Error
429
Too Many Requests Error
500
Internal Server Error