Skip to main content
POST
/
training
Create a custom training
curl --request POST \
  --url https://api.open.cx/training \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "type": "BEHAVIORAL",
  "is_draft": true,
  "directory_id": "<string>",
  "answer": "<string>",
  "question": "<string>",
  "restricted_to_channels": [
    "web"
  ],
  "restricted_to_segments": [
    "<string>"
  ]
}'
{
  "id": "<string>",
  "organization_id": "<string>",
  "question": "<string>",
  "answer": "<string>",
  "is_draft": true,
  "accepted_by": 123,
  "draft_payload": "<any>",
  "learned_from_session_id": "<string>",
  "type": "BEHAVIORAL",
  "restricted_to_segments": [
    "<string>"
  ],
  "restricted_to_channels": [
    "web"
  ],
  "created_at": "<string>",
  "updated_at": "<string>",
  "directory_id": "<string>"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
directory_id
string | null
required

The directory ID for the custom training. This is the ID of the directory that the custom training will be added to. This is optional.

​
answer
string
required

The answer for the custom training. This is the answer for the custom training.

​
question
string
required

The question for the custom training. This is the question for the custom training.

​
restricted_to_channels
enum<string>[]
required

(is array is empty, instruction works for all channels, if array contains channels, instruction is limited to those channels

​
restricted_to_segments
string[]
required

(is array is empty, instruction works for all segments, if array contains segments, instruction is limited to those segments

​
type
enum<string>

The type of custom training. This is the type of custom training that will be created.

Available options:
BEHAVIORAL,
SCENARIO_SPECIFIC
​
is_draft
boolean

The draft status of the custom training. This is the draft status of the custom training.

Response

Returns the created custom training

​
id
string
required

The ID of the custom training

​
organization_id
string
required
​
question
string
required
​
answer
string
required

The answer of the custom training

​
is_draft
boolean
required

The draft status of the custom training

​
accepted_by
number | null
required
​
learned_from_session_id
string | null
required
​
type
enum<string>
required

The type of custom training

Available options:
BEHAVIORAL,
SCENARIO_SPECIFIC
​
restricted_to_segments
string[]
required

(is array is empty, instruction works for all segments, if array contains segments, instruction is limited to those segments

​
restricted_to_channels
enum<string>[]
required

(is array is empty, instruction works for all channels, if array contains channels, instruction is limited to those channels

​
created_at
string
required
​
updated_at
string
required
​
directory_id
string | null
required

The directory ID of the custom training

​
draft_payload
any

Draft payload with structured data

⌘I