Skip to content
AchaduDevelopers
Operational APIGo to website
Dashboard
Developers/API/journey_execute
Journeys

Run journey

Starts an explicit execution for authorized contact or conversation.

POST/journeys/{id}/executejourneys:write
BEHAVIOR

The request validates the input, persists the command, and returns the initial state. Execution can continue in the dedicated queue.

EFFECT

You can create asynchronous work and webhook events after confirmation in the database.

REPETITION

On network failure, confirm the resource status before retrying. Automatically redo only 429 and 5xx with backoff and jitter.

Request

idstring · pathResource identifier.minLength 2 · maxLength 100mandatory
contact_idstring · bodyTarget contact.optional
conversation_idstring · bodyTarget talk.optional
contextobject · bodyNon-context sensitive execution.optional
AuthorizationBearer ach_live_...
Acceptapplication/json
Scopejourneys:write

Executable example

curl
curl -X POST 'https://achadu.com/api/v1/journeys/resource_id/execute' \
  -H 'Authorization: Bearer ach_live_...' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  --data '{
  "contact_id": "string",
  "conversation_id": "string",
  "context": "string"
}'

Response and errors

Every response includes request_id. Lists add pagination; mutable resources return the persisted state after the operation.

200 application/json
{
  "data": {
    "id": "jrn_01J...",
    "name": "Recover interest",
    "trigger": "conversation.updated",
    "blocks": [],
    "active": 1,
    "executions": 42
  },
  "request_id": "req_01J..."
}
200Operation completed.
400Invalid parameter, body or transition.
401Missing, invalid, expired or revoked key.
402The account plan does not release this interface.
403A chave precisa do escopo journeys:write.
404Feature does not exist in this account.
409The current state prevents this operation.
413The JSON body exceeds 128 KB.
429The 120 requests per minute window has been exceeded.