Sign in

v1

latestOpenAPI 3.0.02026-07-26866217.8 KB
Automation

Execute automation action now

Dispatches a waiting message or review automation plan immediately (same behavior as executing an upcoming action in the app). For review plans, the reservation must have reached check-out date in the operator timezone. Requires a writable access token. Only send_message and review plan types are supported.

post/automation/actions/{plan_id}/execute

Path parameters

plan_idinteger required

Automation plan id from GET /automation/actions (data.actions[].id).

Response

Plan was queued for immediate execution.

request_idstring required

Unique identifier for the request.

error_codeinteger required

Numeric error code representing the status of the response. A value of 200 indicates success. <br> See the Error Codes section for more information.

error_msgstring required

Message detailing the status of the response.

Example response

{
  "error_msg": "Done."
}