Create a custom response

Add a single custom response for an agent

POST /autocompose/v1/responses/customs/response

Create a custom response

cURL

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"
}
'

import requests

url = "https://api.sandbox.asapp.com/autocompose/v1/responses/customs/response"

payload = {
    "text": "fold text",
    "title": "folder title",
    "folderId": "123"
}
headers = {
    "asapp-api-id": "<api-key>",
    "asapp-api-secret": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'asapp-api-id': '<api-key>',
    'asapp-api-secret': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({text: 'fold text', title: 'folder title', folderId: '123'})
};

fetch('https://api.sandbox.asapp.com/autocompose/v1/responses/customs/response', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.sandbox.asapp.com/autocompose/v1/responses/customs/response",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'text' => 'fold text',
    'title' => 'folder title',
    'folderId' => '123'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "asapp-api-id: <api-key>",
    "asapp-api-secret: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.sandbox.asapp.com/autocompose/v1/responses/customs/response"

	payload := strings.NewReader("{\n  \"text\": \"fold text\",\n  \"title\": \"folder title\",\n  \"folderId\": \"123\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("asapp-api-id", "<api-key>")
	req.Header.Add("asapp-api-secret", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.sandbox.asapp.com/autocompose/v1/responses/customs/response")
  .header("asapp-api-id", "<api-key>")
  .header("asapp-api-secret", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"text\": \"fold text\",\n  \"title\": \"folder title\",\n  \"folderId\": \"123\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.sandbox.asapp.com/autocompose/v1/responses/customs/response")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["asapp-api-id"] = '<api-key>'
request["asapp-api-secret"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"text\": \"fold text\",\n  \"title\": \"folder title\",\n  \"folderId\": \"123\"\n}"

response = http.request(request)
puts response.read_body

200

{
  "id": "<string>",
  "text": "<string>",
  "title": "<string>",
  "folderId": "<string>",
  "metadata": [
    {
      "name": "<string>",
      "allowedValues": [
        "<string>"
      ]
    }
  ]
}

{
  "error": {
    "requestId": "8e033668-9f1a-11ec-b909-0242ac120002",
    "code": "400-01",
    "message": "Bad request"
  }
}

{
  "error": {
    "requestId": "8e033668-9f1a-11ec-b909-0242ac120002",
    "code": "401-01",
    "message": "Unauthorized"
  }
}

{
  "error": {
    "requestId": "8e033668-9f1a-11ec-b909-0242ac120002",
    "code": "403-01",
    "message": "Forbidden Response"
  }
}

{
  "error": {
    "requestId": "8e033668-9f1a-11ec-b909-0242ac120002",
    "code": "404-01",
    "message": "Not Found"
  }
}

{
  "error": {
    "requestId": "8e033668-9f1a-11ec-b909-0242ac120002",
    "code": "409-01",
    "message": "Conflict"
  }
}

{
  "error": {
    "requestId": "8e033668-9f1a-11ec-b909-0242ac120002",
    "code": "413-01",
    "message": "Request Entity Too Large"
  }
}

{
  "error": {
    "requestId": "8e033668-9f1a-11ec-b909-0242ac120002",
    "code": "422-01",
    "message": "Unprocessable Entity"
  }
}

{
  "error": {
    "requestId": "8e033668-9f1a-11ec-b909-0242ac120002",
    "code": "429-01",
    "message": "Too Many Requests"
  }
}

{
  "error": {
    "requestId": "8e033668-9f1a-11ec-b909-0242ac120002",
    "code": "503-01",
    "message": "Service Unavailable"
  }
}

{
  "error": {
    "requestId": "8e033668-9f1a-11ec-b909-0242ac120002",
    "code": "500-01",
    "message": "Internal server error"
  }
}

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.

Show child attributes

Response

200

application/json

Acknowledgement that the response was successfully added

id · string · read-only

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.

Show child attributes