v1

latestOpenAPI 3.1.0MIT2026-07-26134154266.9 KB

Update a training

Update an existing training.

put/training/{id}

Path parameters

idstring required

Request body

titlestring required

The scenario title or trigger phrase

contentstring required

The instruction body — how the AI should respond

type'BEHAVIORAL' | 'SCENARIO_SPECIFIC'

BEHAVIORAL (always active) or SCENARIO_SPECIFIC (semantic match, default)

is_draftboolean

If true, saved as draft and not used by the AI

directory_idstring nullable

Directory ID to organize into

restricted_to_channelsSessionChannel[]

Limit to specific channels (empty = all)

restricted_to_segmentsstring[]

Limit to specific segments (empty = all)

metadataobject

Arbitrary key-value metadata for external integrations

start_timestring date-time nullable

ISO 8601 instant (UTC) when the AI may start using this instruction. Null clears the start bound.

end_timestring date-time nullable

ISO 8601 instant (UTC) when the AI stops using this instruction. Null clears the end bound.

Response

Default Response

idstring required

Unique training ID

titlestring required

The scenario title or trigger phrase (last published version)

contentstring required

The instruction body — how the AI should respond (last published version)

draft_titlestring nullable required

Draft title being edited (null if no draft exists). Use draft_title ?? title.

draft_contentstring nullable required

Draft body being edited (null if no draft exists). Use draft_content ?? content.

type'BEHAVIORAL' | 'SCENARIO_SPECIFIC' required

BEHAVIORAL (always active) or SCENARIO_SPECIFIC (semantic match)

is_draftboolean required

Draft trainings are saved but not used by the AI

directory_idstring nullable required

Directory this training belongs to

restricted_to_channelsSessionChannel[] required

Channels this applies to (empty = all)

restricted_to_segmentsstring[] required

Contact segments this applies to (empty = all)

current_versionnumber nullable required

Active published version number (null if unpublished draft)

metadataobject nullable required

Arbitrary key-value metadata for external integrations

published_atstring date-time nullable required

When the current version was published

start_timestring date-time nullable required

Active window start (UTC). Null = no start bound.

end_timestring date-time nullable required

Active window end (UTC). Null = no end bound.

created_atstring date-time required

updated_atstring date-time required