POST
/
autocompose
/
v1
/
responses
/
customs
/
response
Create a custom response
curl --request POST \
  --url https://api.sandbox.asapp.com/autocompose/v1/responses/customs/response \
  --header 'Content-Type: application/json' \
  --header 'asapp-api-id: <api-key>' \
  --header 'asapp-api-secret: <api-key>' \
  --data '{
  "text": "fold text",
  "title": "folder title",
  "folderId": "123"
}'
{
  "id": "<string>",
  "text": "<string>",
  "title": "<string>",
  "folderId": "<string>",
  "metadata": [
    {
      "name": "<string>",
      "allowedValues": [
        "<string>"
      ]
    }
  ]
}

Authorizations

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

Query Parameters

​
agentId
string
required

Identifier of the agent, data format is expected to be UUID

Body

application/json

The custom response to be added

​
text
string
required

The text of the response

​
title
string
required

The title of the response

​
folderId
string

the ID of the folder the response belongs to (used for custom responses).

​
metadata
object[]

free-form metadata, in the form of a map of keys to lists of allowed values for each key, that can be added to any response. At least one of the values in the list for each key included here must match what gets sent when requesting suggestions, so that responses can be filtered appropriately.

Response

Acknowledgement that the response was successfully added

​
id
string

The ID of this response, data format is UUID

​
text
string

The text of the response

​
title
string

The title of the response. Always non-empty for custom responses, but may be empty for other types of responses (global and organic).

​
folderId
string

the ID of the folder the response belongs to.

​
metadata
object[]

free-form metadata, in the form of a map of keys to lists of allowed values for each key, that can be added to any response. At least one of the values in the list for each key included here must match what gets sent when requesting suggestions, so that responses can be filtered appropriately.