Create a structured data field

Creates a new structured data field configuration that defines what information should be extracted from conversations.

This endpoint supports creating two types of structured data fields:

1. QUESTION type: Defines specific questions to be answered about the conversation Example: “Did the agent offer the correct promotion?”

2. ENTITY type: Defines entities to be identified and extracted Example: Product names mentioned in the conversation

These fields are used by the Structured Data API (/apis/autosummary/retrieve-structured-data) to automatically extract the configured information from conversations.

POST /configuration/v1/structured-data-fields

Create a structured data field

cURL

curl --request POST \
  --url https://api.sandbox.asapp.com/configuration/v1/structured-data-fields \
  --header 'Content-Type: application/json' \
  --header 'asapp-api-id: <api-key>' \
  --header 'asapp-api-secret: <api-key>' \
  --data '
{
  "id": "q_promotion_was_offered",
  "name": "Promotion was offered",
  "categoryId": "OUTCOME",
  "type": "QUESTION",
  "question": {
    "question": "Did the agent offer the correct promotion?"
  },
  "active": true
}
'

import requests

url = "https://api.sandbox.asapp.com/configuration/v1/structured-data-fields"

payload = {
    "id": "q_promotion_was_offered",
    "name": "Promotion was offered",
    "categoryId": "OUTCOME",
    "type": "QUESTION",
    "question": { "question": "Did the agent offer the correct promotion?" },
    "active": True
}
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({
    id: 'q_promotion_was_offered',
    name: 'Promotion was offered',
    categoryId: 'OUTCOME',
    type: 'QUESTION',
    question: {question: 'Did the agent offer the correct promotion?'},
    active: true
  })
};

fetch('https://api.sandbox.asapp.com/configuration/v1/structured-data-fields', 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/configuration/v1/structured-data-fields",
  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([
    'id' => 'q_promotion_was_offered',
    'name' => 'Promotion was offered',
    'categoryId' => 'OUTCOME',
    'type' => 'QUESTION',
    'question' => [
        'question' => 'Did the agent offer the correct promotion?'
    ],
    'active' => true
  ]),
  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/configuration/v1/structured-data-fields"

	payload := strings.NewReader("{\n  \"id\": \"q_promotion_was_offered\",\n  \"name\": \"Promotion was offered\",\n  \"categoryId\": \"OUTCOME\",\n  \"type\": \"QUESTION\",\n  \"question\": {\n    \"question\": \"Did the agent offer the correct promotion?\"\n  },\n  \"active\": true\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/configuration/v1/structured-data-fields")
  .header("asapp-api-id", "<api-key>")
  .header("asapp-api-secret", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"id\": \"q_promotion_was_offered\",\n  \"name\": \"Promotion was offered\",\n  \"categoryId\": \"OUTCOME\",\n  \"type\": \"QUESTION\",\n  \"question\": {\n    \"question\": \"Did the agent offer the correct promotion?\"\n  },\n  \"active\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.sandbox.asapp.com/configuration/v1/structured-data-fields")

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  \"id\": \"q_promotion_was_offered\",\n  \"name\": \"Promotion was offered\",\n  \"categoryId\": \"OUTCOME\",\n  \"type\": \"QUESTION\",\n  \"question\": {\n    \"question\": \"Did the agent offer the correct promotion?\"\n  },\n  \"active\": true\n}"

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

201

{
  "id": "q_promotion_was_offered",
  "name": "Promotion was offered",
  "categoryId": "OUTCOME",
  "type": "QUESTION",
  "question": {
    "question": "Did the agent offer the correct promotion?"
  },
  "active": true
}

{
  "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": "500-01",
    "message": "Internal server error"
  }
}

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

Authorizations

asapp-api-id · string · header · required

asapp-api-secret · string · header · required

Body

application/json

Question

Entity

id · string · required

The id of the structured data field

Example:

"q_promotion_was_offered"

name · string · required

The name of the structured data field

Example:

"Promotion was offered"

categoryId · string · required

The category of the structured data field. Possible values:

• OUTCOME

Example:

"OUTCOME"

type · string · required

The type of the structured data field. Must be either:

• QUESTION
• ENTITY

Example:

"QUESTION"

active · boolean · required

Indicates if the structured data is active or not.

Example:

false

question · object · required

Show child attributes

segmentIds · string[] · required

The segment ids that the structured data field is associated with

Response

201

application/json

Structured data field created.

Question

Entity

id · string · required

The id of the structured data field

Example:

"q_promotion_was_offered"

name · string · required

The name of the structured data field

Example:

"Promotion was offered"

categoryId · string · required

The category of the structured data field. Possible values:

• OUTCOME

Example:

"OUTCOME"

type · string · required

The type of the structured data field. Must be either:

• QUESTION
• ENTITY

Example:

"QUESTION"

active · boolean · required

Indicates if the structured data is active or not.

Example:

false

question · object · required

Show child attributes

segmentIds · string[] · required

The segment ids that the structured data field is associated with