Skip to main content
POST
/
conversation
/
v1
/
conversations
/
{conversationId}
/
authenticate
Authenticate a user in a conversation
curl --request POST \
  --url https://api.sandbox.asapp.com/conversation/v1/conversations/{conversationId}/authenticate \
  --header 'Content-Type: application/json' \
  --header 'asapp-api-id: <api-key>' \
  --header 'asapp-api-secret: <api-key>' \
  --data '
{
  "customerExternalId": "customer-xyz",
  "token": "cGFzc3dvcmQ="
}
'
{
  "error": {
    "requestId": "8e033668-9f1a-11ec-b909-0242ac120002",
    "code": "400-01",
    "message": "Bad request"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.asapp.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
asapp-api-id
string
header
required
​
asapp-api-secret
string
header
required

Path Parameters

​
conversationId
string
required

The identifier for a conversation.

Pattern: ^[A-Z0-9]+$

Body

application/json

Contains authentication information for a customer in a conversation.

​
customerExternalId
string
required

The unique identifier for the customer in your external system.

Example:

"a03839d6-461c-479c-99db-8160174ef12d"

​
auth
object
required

An authentication payload that could contain different types of credentials, such as a token, used to authenticate an end user. All of the fields are optional, but at least one will be required

​
streamId
string

The unique identifier for the connection where responses should be sent.

Example:

"97555020-0276-435f-8104-c378221ba292"

Response

204 - No Content