Sign in

v1

latestOpenAPI 3.1.0MIT2026-07-26134154266.9 KB

Create an action

Create a new action that the AI agent can call during conversations. The payload field uses OpenAPI-style parameter and request body specifications to define how the API call should be constructed.

post/actions

Request body

namestring required

Action display name

descriptionstring

What this action does

api_endpointstring uri required

The full API endpoint URL to call

request_type'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE' required

HTTP method

operation_idstring

Unique operation ID (auto-generated from name if omitted)

pinnedboolean

Whether to pin this action prominently

tagsstring[]

Tags for organizing actions

require_form_submissionboolean

Require the user to submit a form before executing

restricted_to_segmentsstring[]

Contact segment ids this action is restricted to. Empty/omit = available to all contacts. Segment ids come from list contact segments.

Response

Default Response

idstring required

Unique action ID

namestring required

Action display name

descriptionstring nullable required

What this action does

api_endpointstring nullable required

The API endpoint URL this action calls

request_typestring nullable required

HTTP method (GET, POST, PUT, PATCH, DELETE)

operation_idstring nullable required

Unique operation ID used to reference this action

statusstring nullable required

Action status (e.g. "live")

pinnedboolean required

Whether this action is pinned prominently

tagsstring[] required

Tags for organizing actions

is_handoff_likeboolean required

Whether this action behaves like a handoff to a human agent

require_form_submissionboolean nullable required

Whether a form must be submitted before the action executes

restricted_to_segmentsstring[] required

Contact segment ids this action is restricted to. Empty = available to all contacts.

created_atstring date-time required

When the action was created

updated_atstring date-time required

When the action was last updated