Skip to main content

Execute engagement context action

Resolve or create a lead and execute a selected CRM workflow action.

POST/api/engagement-context/actions
HTTP referenceScope authenticated user session (developer API keys blocked)Updated September 27, 2026

This page documents the canonical HTTP contract for this endpoint.

Session-only endpoint; authenticate with the signed-in user JWT; developer API keys are blocked. Actions can create or update CRM state. idempotency_key and sequence_id are accepted only for enroll_sequence. The response is a strict action receipt with lead outcome and operation details.

Body parameters

  • schema_version · optional

    string

    engagement_context.action.v1

  • actionrequired

    string

    Backend EngagementAction enum; sequence_id required only for enroll_sequence.

  • contextrequired

    object

    EngagementContextResolveCommand.

  • sequence_id · optional

    string

  • idempotency_key · optional

    string

    Only for enroll_sequence; 8–200 characters.

Errors

StatusMeaning
401Signed-in user JWT required.
403Developer API keys are blocked for this session-only route.
422Action/context combination or idempotency key is invalid.

Docs