Skip to content

Automations

Update an automation

Partially updates a rule: send only the fields you want to change, and the others stay as they are. The same validation as for creating a rule applies to the fields you send. Returns the updated automation.

PATCH/api/v1/automations/{id}
  • Console only: owner or admin
  • Workspace: X-Tenant-ID

Path parameters

  • iduuidrequired

    Automation id.

    Example
    4d5e6f70-8192-4a3b-b4c5-d6e7f8091a2b

Headers

  • Cookiestringrequired

    The whatsappx_session cookie the app sets when you sign in. Browsers send it automatically; API keys are not accepted on this endpoint.

    Example
    whatsappx_session=…
  • X-Tenant-IDuuidrequired

    Workspace id. Required for session requests. You can pass ?tenant=<id> instead.

    Example
    8d0f6c2e-3b1a-4c55-9a7e-2f4b6d1e9c30

Body

application/json
  • namestringoptional

    New rule name.

    Constraints
    2–100 characters.
  • keywordstringoptional

    New keyword. Stored in lower case.

    Constraints
    1–100 characters.
  • replystringoptional

    New reply text.

    Constraints
    1–4096 characters.
  • enabledbooleanoptional

    true to turn the rule on, false to turn it off.

    Example
    false

Response

200 OKapplication/json

  • iduuid

    Automation id.

  • namestring

    Rule name.

  • keywordstring

    Keyword, stored in lower case.

  • replystring

    Text sent back when the keyword matches.

  • enabledinteger

    1 when the rule is on, 0 when it is off.

  • runsinteger

    How many times the rule has replied.

  • created_atinteger

    Creation time in Unix seconds.

Status codes

  • 200OK. The updated automation.
  • 400Bad request. No field was sent (provide name, keyword, reply or enabled), a field failed validation (same messages as when creating), the body is not valid JSON (invalid body), or the id is invalid (invalid automation id).
  • 401Unauthorized. No signed-in session (unauthorized).
  • 403Forbidden. API keys can never call this endpoint (API keys cannot administer workspaces). A signed-in user who is not an owner or admin gets admin required; a user who is not a member of the workspace gets forbidden.
  • 404Not found. No automation with this id in the workspace.
  • 500Server error. The rule could not be updated.