Create or update a conversation

Creates a new conversation or updates an existing one based on the provided externalId.

Use this endpoint when:

• Starting a new conversation
• Updating conversation details (e.g., reassigning to a different agent)

If the externalId is not found, a new conversation will be created. Otherwise, the existing conversation will be updated.

Authorizations

asapp-api-id

string

header

required

asapp-api-secret

string

header

required

Body

application/json

Conversation between an agent and a customer that requires a timestamp of creation

customer

object

required

Information about the customer participating in the conversation.

Show child attributes

customer.externalId

string

required

The unique identifier for the customer in your external system.

customer.name

string

The display name of the customer.

externalId

string

required

Your unique identifier for a conversation.

timestamp

string

required

The time when the conversation was created. Include the timezone, otherwise UTC will be assumed.

agent

object

Information about the agent participating in the conversation.

Show child attributes

agent.externalId

string

required

The unique identifier for the agent in your external system.

agent.name

string

The display name of the agent.

id

string

The identifier of the conversation.

metadata

object

Additional key-value pairs to store custom metadata about the conversation. Use this for filtering or categorization purposes.

Show child attributes

metadata.{key}

string

Response

200 - application/json

Response for conversation

id

string

The identifier of the conversation.