Skip to main content
POST
/
conversation
/
v1
/
conversations
Create or update a conversation
curl --request POST \
  --url https://api.sandbox.asapp.com/conversation/v1/conversations \
  --header 'Content-Type: application/json' \
  --header 'asapp-api-id: <api-key>' \
  --header 'asapp-api-secret: <api-key>' \
  --data '
{
  "externalId": "id-111",
  "agent": {
    "externalId": "agent-111",
    "name": "agent-x"
  },
  "customer": {
    "externalId": "customer-x",
    "name": "customer-name-x"
  },
  "metadata": {
    "organizationalGroup": "some-group",
    "subdivision": "some-division",
    "queue": "some-queue"
  },
  "timestamp": "2021-11-23T12:13:14.555Z"
}
'
{
  "id": "01BX5ZZKBKACTAV9WEVGEMMVRZ"
}

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

​
externalId
string
required

Your unique identifier for a conversation.

​
customer
object
required

Information about the customer participating in the conversation.

​
timestamp
string<date-time>
required

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

​
id
string

The identifier of the conversation.

​
agent
object

Information about the agent participating in the conversation.

​
metadata
object

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

Response

Successfully created or updated conversation

Response for conversation

​
id
string

The identifier of the conversation.