Console

Update automation

.md

PATCH

https://whatsapp.paaltech.org/api/v1/businesses/{external_id}/automations/{id}

Token ability: automations.manage · Authentication

Change any part, or status (active or paused). Pausing stops its waiting runs.

Path parameters

external_id string required

Your own ID for the business (Multi-SKUUL - the tenant ID).

Max 191 characters. Pattern ^[A-Za-z0-9._:-]+$.

id integer required

Body parameters

name string required

Max 191 characters.

trigger string required

One of: message_received, keyword, contact_created, conversation_status, date_reached.

trigger_config object | null

keyword: {keywords: [...]}; conversation_status: {status}; date_reached: {field: a date custom field, offset_days: -3 = three days before}.

conditions object | null

{"all": [...]} or {"any": [...]} of conditions {"field", "op", "value"} or nested groups (3 levels, 30 conditions). Fields: name, phone, email, locale, timezone, external_id, created_at, tag (has, not_has), consent.<category> (eq granted|revoked|none), last_incoming_at (within_days, older_than_days), custom.<key> (by the field's type). Ops: eq, neq, gt, gte, lt, lte, contains, starts_with, in, exists, not_exists, within_days, older_than_days.

Example {"all":[{"field":"custom.class","op":"eq","value":"SHS 2"},{"field":"custom.fee_balance","op":"gt","value":0}]}.

steps array of objects required

In order. send_template {template, language, parameters, category?, topic?}; send_text {text} (inside the 24-hour window); add_tag / remove_tag {tag}; set_status {status}; add_note {text}; notify {data} (automation.action callback); wait {minutes | hours | days}.

Max 20 items.

status string

One of: active, paused.

Responses

200

Updated.

401

unauthenticated - missing, invalid, revoked or expired token

403

missing_ability, product_suspended or product_token_required

404

not_found - not yours, or does not exist

422

validation_failed - fields are invalid; see errors.

429

rate_limited - over 300 requests/minute for this product

Errors always look like {"error": {"code", "message"}} - see Errors and status codes.

Language

Credentials

Authorization Bearer $PAALCHAT_TOKEN

Request

cURL

curl --request PATCH \
  --url 'https://whatsapp.paaltech.org/api/v1/businesses/presec/automations/2' \
  --header "Authorization: Bearer $PAALCHAT_TOKEN" \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{"status": "paused"}'

const response = await fetch('https://whatsapp.paaltech.org/api/v1/businesses/presec/automations/2', {
  method: 'PATCH',
  headers: {
    Authorization: `Bearer ${process.env.PAALCHAT_TOKEN}`,
    Accept: 'application/json',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({"status": "paused"}),
});

const data = await response.json();
console.log(response.status, data);

use Illuminate\Support\Facades\Http;

$response = Http::withToken(env('PAALCHAT_TOKEN'))
    ->acceptJson()
    ->patch('https://whatsapp.paaltech.org/api/v1/businesses/presec/automations/2', ['status' => 'paused']);

$data = $response->json();

import os
import requests

response = requests.patch(
    "https://whatsapp.paaltech.org/api/v1/businesses/presec/automations/2",
    headers={"Authorization": f"Bearer {os.environ['PAALCHAT_TOKEN']}", "Accept": "application/json"},
    json={"status": "paused"},
)

print(response.status_code, response.json())

require 'net/http'
require 'json'

uri = URI('https://whatsapp.paaltech.org/api/v1/businesses/presec/automations/2')
request = Net::HTTP::Patch.new(uri)
request['Authorization'] = "Bearer #{ENV['PAALCHAT_TOKEN']}"
request['Accept'] = 'application/json'
request['Content-Type'] = 'application/json'
request.body = <<~JSON
  {"status": "paused"}
JSON

response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }
puts response.code, JSON.parse(response.body)

package main

import (
	"fmt"
	"io"
	"net/http"
	"os"
	"strings"
)

func main() {
	req, err := http.NewRequest("PATCH", "https://whatsapp.paaltech.org/api/v1/businesses/presec/automations/2", strings.NewReader(`{"status": "paused"}`))
	if err != nil {
		panic(err)
	}
	req.Header.Set("Authorization", "Bearer "+os.Getenv("PAALCHAT_TOKEN"))
	req.Header.Set("Accept", "application/json")
	req.Header.Set("Content-Type", "application/json")

	res, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer res.Body.Close()

	out, _ := io.ReadAll(res.Body)
	fmt.Println(res.StatusCode, string(out))
}

Try it with a test key

Only sk_test_ keys: requests reach your sandbox businesses, never real ones. The key is not saved.

Test key

external_id

id

JSON body

Response

Response

{
  "error": {"code": "unauthenticated", "message": "A valid product token is required."}
}

{
  "error": {
    "code": "missing_ability",
    "message": "This token does not have the ability this request needs."
  }
}

{"error": {"code": "not_found", "message": "Business not found."}}

{
  "error": {
    "code": "validation_failed",
    "message": "The external id field format is invalid. (and 1 more error)"
  },
  "errors": {
    "external_id": ["The external id field format is invalid."],
    "name": ["The name field is required."]
  }
}

{
  "error": {
    "code": "rate_limited",
    "message": "Too many requests. Slow down and retry after the Retry-After header."
  }
}