Update a custom training

Update an existing custom training entry identified by its ID. This allows you to modify the title, body, or category of a custom training.

PUT /training/{id}

Update a custom training

cURL

curl --request PUT \
  --url https://api.open.cx/training/{id} \
  --header 'Content-Type: application/json' \
  --data '
{
  "directory_id": "<string>",
  "answer": "<string>",
  "question": "<string>",
  "restricted_to_channels": [
    "web"
  ],
  "restricted_to_segments": [
    "<string>"
  ],
  "type": "BEHAVIORAL",
  "is_draft": true
}
'

200

{
  "id": "<string>",
  "organization_id": "<string>",
  "question": "<string>",
  "answer": "<string>",
  "is_draft": true,
  "accepted_by": 123,
  "learned_from_session_id": "<string>",
  "type": "BEHAVIORAL",
  "restricted_to_segments": [
    "<string>"
  ],
  "restricted_to_channels": [
    "web"
  ],
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "directory_id": "<string>",
  "draft_payload": "<unknown>"
}

Path Parameters

id · string · required

The unique identifier of the custom training

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

Available options: web, email, phone_voice, slack, sms, whatsapp, instagram, messenger, api, web_voice

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

200

application/json

Default Response

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

Available options: web, email, phone_voice, slack, sms, whatsapp, instagram, messenger, api, web_voice

created_at · string<date-time> · required

updated_at · string<date-time> · required

directory_id · string | null · required

The directory ID of the custom training

draft_payload · any