Languages: every operation supports cURL, Node.js (TypeScript), Python, Go, Ruby, and PHP. The first 15 operations on this page show all six languages; the remaining 77 show cURL and TypeScript — the two most-used.

WhatsApp API

WhatsApp endpoints exposed by the Devotel CPaaS API Base path: /api/v1/whatsapp Endpoint count: 92

title: “Worked samples” description: “Read → update → re-read the conversational-automation config (ice breakers, slash commands, welcome toggle), an interactive send with the full envelope, the test-account analytics envelope, and validation errors.”

Worked request and response samples

Copy a request as written, substitute your own values, and compare the response envelope. The conversational-automation chain a WhatsApp admin runs: read the config → write the full desired state → re-read to verify. Every sample below pairs curl with raw Node and Python (fetch / requests) — the Node SDK’s client.request(method, path, body) escape hatch and the Python SDK take the same route shape. Template sends live elsewhere. The loop for approved-template sends (GET /templates → POST /api/v1/messages/whatsapp) is worked end to end in API recipes, task 13. This overlay covers the operations on this page: the WhatsApp-specific config surface, interactive sends, and test-account analytics.

1. Read the conversational-automation config

GET /api/v1/whatsapp/conversational-automation

This returns the first-open affordances on your organization’s default WhatsApp connection: the welcome-message toggle, up to four ice breakers (prompts), and the slash-command menu (commands) — the same object you send back on update.

curl -X GET "https://api.orbit.devotel.io/api/v1/whatsapp/conversational-automation" \
  -H "X-API-Key: dv_live_sk_your_key_here"

const res = await fetch(
  "https://api.orbit.devotel.io/api/v1/whatsapp/conversational-automation",
  { headers: { "X-API-Key": process.env.ORBIT_API_KEY! } },
);
console.log(await res.json());

import os, requests

headers = {"X-API-Key": os.environ["ORBIT_API_KEY"]}
r = requests.get(
    "https://api.orbit.devotel.io/api/v1/whatsapp/conversational-automation",
    headers=headers,
)
print(r.json())

{
  "data": {
    "enable_welcome_message": true,
    "prompts": [
      "Track my order",
      "Talk to support",
      "See opening hours"
    ],
    "commands": [
      {
        "command_name": "order_status",
        "command_description": "Check where your order is"
      },
      {
        "command_name": "support",
        "command_description": "Open a support conversation"
      }
    ]
  },
  "meta": {
    "request_id": "req_wa_ca_get",
    "timestamp": "2026-08-30T12:00:00.000Z"
  }
}

2. Update the config (full desired state)

PUT /api/v1/whatsapp/conversational-automation

WhatsApp replaces each field present on the write, so send the complete desired state — omitting prompts clears the ice breakers rather than leaving them as they were. Owners and admins only. command_name must be lowercase letters, digits, and underscores (no spaces); the caps — at most four ice breakers of 80 characters each, at most 30 commands — are validated here, so a bad config returns a 422 before it reaches Meta. Request

cURL

curl -X PUT "https://api.orbit.devotel.io/api/v1/whatsapp/conversational-automation" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{
  "enable_welcome_message": true,
  "prompts": [
    "Track my order",
    "Talk to support",
    "See opening hours"
  ],
  "commands": [
    {
      "command_name": "order_status",
      "command_description": "Check where your order is"
    },
    {
      "command_name": "support",
      "command_description": "Open a support conversation"
    }
  ]
}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/whatsapp/conversational-automation', {
  method: 'PUT',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
  "enable_welcome_message": true,
  "prompts": [
    "Track my order",
    "Talk to support",
    "See opening hours"
  ],
  "commands": [
    {
      "command_name": "order_status",
      "command_description": "Check where your order is"
    },
    {
      "command_name": "support",
      "command_description": "Open a support conversation"
    }
  ]
}),
})
console.log(await res.json())

Python

import os, requests

headers = {"X-API-Key": os.environ["ORBIT_API_KEY"]}
headers["Content-Type"] = "application/json"
r = requests.put("https://api.orbit.devotel.io/api/v1/whatsapp/conversational-automation", headers=headers, json={
  "enable_welcome_message": true,
  "prompts": [
    "Track my order",
    "Talk to support",
    "See opening hours"
  ],
  "commands": [
    {
      "command_name": "order_status",
      "command_description": "Check where your order is"
    },
    {
      "command_name": "support",
      "command_description": "Open a support conversation"
    }
  ]
})
print(r.json())

package main

import (
	"bytes"
	"net/http"
	"os"
)

func main() {
	req, _ := http.NewRequest("PUT", "https://api.orbit.devotel.io/api/v1/whatsapp/conversational-automation", bytes.NewBuffer([]byte(`{
  "enable_welcome_message": true,
  "prompts": [
    "Track my order",
    "Talk to support",
    "See opening hours"
  ],
  "commands": [
    {
      "command_name": "order_status",
      "command_description": "Check where your order is"
    },
    {
      "command_name": "support",
      "command_description": "Open a support conversation"
    }
  ]
}`)))
	req.Header.Set("X-API-Key", os.Getenv("ORBIT_API_KEY"))
	req.Header.Set("Content-Type", "application/json")
	http.DefaultClient.Do(req)
}

Ruby

require 'net/http'
require 'json'

uri = URI('https://api.orbit.devotel.io/api/v1/whatsapp/conversational-automation')
req = Net::HTTP::Put.new(uri)
req['X-API-Key'] = ENV['ORBIT_API_KEY']
req['Content-Type'] = 'application/json'
req.body = {
  "enable_welcome_message": true,
  "prompts": [
    "Track my order",
    "Talk to support",
    "See opening hours"
  ],
  "commands": [
    {
      "command_name": "order_status",
      "command_description": "Check where your order is"
    },
    {
      "command_name": "support",
      "command_description": "Open a support conversation"
    }
  ]
}.to_json
res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts res.body

PHP

<?php
$ch = curl_init('https://api.orbit.devotel.io/api/v1/whatsapp/conversational-automation');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'PUT');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  'X-API-Key: ' . getenv('ORBIT_API_KEY'),
  'Content-Type: application/json',
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, <<<JSON
{
  "enable_welcome_message": true,
  "prompts": [
    "Track my order",
    "Talk to support",
    "See opening hours"
  ],
  "commands": [
    {
      "command_name": "order_status",
      "command_description": "Check where your order is"
    },
    {
      "command_name": "support",
      "command_description": "Open a support conversation"
    }
  ]
}
JSON);
echo curl_exec($ch);

{
  "data": {
    "ok": true
  },
  "meta": {
    "request_id": "req_wa_ca_put",
    "timestamp": "2026-08-30T12:00:05.000Z"
  }
}

Re-read with step 1 to confirm the state Meta accepted. A field violation comes back as 422 with the offending field in error.details — for example a command_name with a space or an upper-case letter:

422

{
  "error": {
    "code": "VALIDATION_ERROR",
    "status": 422,
    "message": "Request validation failed.",
    "details": {
      "field": "commands.0.command_name"
    }
  },
  "meta": {
    "request_id": "req_wa_ca_err",
    "timestamp": "2026-08-30T12:00:06.000Z"
  }
}

3. Send an interactive message

POST /api/v1/whatsapp/messages/send-interactive

Inside the recipient’s 24-hour customer-service window you can send without a template. action.buttons takes up to three reply buttons; the tap returns on your inbound webhook as button_reply. A list menu (action.button + action.sections) is the alternative shape. Request

cURL

curl -X POST "https://api.orbit.devotel.io/api/v1/whatsapp/messages/send-interactive" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{
  "to": "+14155552671",
  "header": "Order status",
  "body": "Your order #4821 is packed. Choose an update:",
  "action": {
    "buttons": [
      {
        "type": "reply",
        "reply": {
          "id": "track",
          "title": "Track it"
        }
      },
      {
        "type": "reply",
        "reply": {
          "id": "change",
          "title": "Change delivery"
        }
      }
    ]
  }
}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/whatsapp/messages/send-interactive', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
  "to": "+14155552671",
  "header": "Order status",
  "body": "Your order #4821 is packed. Choose an update:",
  "action": {
    "buttons": [
      {
        "type": "reply",
        "reply": {
          "id": "track",
          "title": "Track it"
        }
      },
      {
        "type": "reply",
        "reply": {
          "id": "change",
          "title": "Change delivery"
        }
      }
    ]
  }
}),
})
console.log(await res.json())

Python

import os, requests

headers = {"X-API-Key": os.environ["ORBIT_API_KEY"]}
headers["Content-Type"] = "application/json"
r = requests.post("https://api.orbit.devotel.io/api/v1/whatsapp/messages/send-interactive", headers=headers, json={
  "to": "+14155552671",
  "header": "Order status",
  "body": "Your order #4821 is packed. Choose an update:",
  "action": {
    "buttons": [
      {
        "type": "reply",
        "reply": {
          "id": "track",
          "title": "Track it"
        }
      },
      {
        "type": "reply",
        "reply": {
          "id": "change",
          "title": "Change delivery"
        }
      }
    ]
  }
})
print(r.json())

package main

import (
	"bytes"
	"net/http"
	"os"
)

func main() {
	req, _ := http.NewRequest("POST", "https://api.orbit.devotel.io/api/v1/whatsapp/messages/send-interactive", bytes.NewBuffer([]byte(`{
  "to": "+14155552671",
  "header": "Order status",
  "body": "Your order #4821 is packed. Choose an update:",
  "action": {
    "buttons": [
      {
        "type": "reply",
        "reply": {
          "id": "track",
          "title": "Track it"
        }
      },
      {
        "type": "reply",
        "reply": {
          "id": "change",
          "title": "Change delivery"
        }
      }
    ]
  }
}`)))
	req.Header.Set("X-API-Key", os.Getenv("ORBIT_API_KEY"))
	req.Header.Set("Content-Type", "application/json")
	http.DefaultClient.Do(req)
}

Ruby

require 'net/http'
require 'json'

uri = URI('https://api.orbit.devotel.io/api/v1/whatsapp/messages/send-interactive')
req = Net::HTTP::Post.new(uri)
req['X-API-Key'] = ENV['ORBIT_API_KEY']
req['Content-Type'] = 'application/json'
req.body = {
  "to": "+14155552671",
  "header": "Order status",
  "body": "Your order #4821 is packed. Choose an update:",
  "action": {
    "buttons": [
      {
        "type": "reply",
        "reply": {
          "id": "track",
          "title": "Track it"
        }
      },
      {
        "type": "reply",
        "reply": {
          "id": "change",
          "title": "Change delivery"
        }
      }
    ]
  }
}.to_json
res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts res.body

PHP

<?php
$ch = curl_init('https://api.orbit.devotel.io/api/v1/whatsapp/messages/send-interactive');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  'X-API-Key: ' . getenv('ORBIT_API_KEY'),
  'Content-Type: application/json',
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, <<<JSON
{
  "to": "+14155552671",
  "header": "Order status",
  "body": "Your order #4821 is packed. Choose an update:",
  "action": {
    "buttons": [
      {
        "type": "reply",
        "reply": {
          "id": "track",
          "title": "Track it"
        }
      },
      {
        "type": "reply",
        "reply": {
          "id": "change",
          "title": "Change delivery"
        }
      }
    ]
  }
}
JSON);
echo curl_exec($ch);

{
  "data": {
    "message_id": "wamid.HBgNMTIzNDU2Nzg5MGFiY2Rl",
    "to": "+14155552671",
    "status": "accepted"
  },
  "meta": {
    "request_id": "req_wa_ix_send",
    "timestamp": "2026-08-30T12:01:00.000Z"
  }
}

4. Test-account analytics KPIs

GET /api/v1/whatsapp/test-account/analytics

Pre-aggregated counts for the test-account analytics card in the dashboard, scoped to your OTP-verified test recipient. Read-only aggregate with no provider or billing side-effect. daily holds up to 30 data points, oldest first. Request

cURL

curl -X GET "https://api.orbit.devotel.io/api/v1/whatsapp/test-account/analytics" \
  -H "X-API-Key: dv_live_sk_your_key_here" 

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/whatsapp/test-account/analytics', {
  method: 'GET',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
  },
})
console.log(await res.json())

Python

import os, requests

headers = {"X-API-Key": os.environ["ORBIT_API_KEY"]}
r = requests.get("https://api.orbit.devotel.io/api/v1/whatsapp/test-account/analytics", headers=headers)
print(r.json())

package main

import (
	"bytes"
	"net/http"
	"os"
)

func main() {
	req, _ := http.NewRequest("GET", "https://api.orbit.devotel.io/api/v1/whatsapp/test-account/analytics", nil)
	req.Header.Set("X-API-Key", os.Getenv("ORBIT_API_KEY"))

	http.DefaultClient.Do(req)
}

Ruby

require 'net/http'
require 'json'

uri = URI('https://api.orbit.devotel.io/api/v1/whatsapp/test-account/analytics')
req = Net::HTTP::Get.new(uri)
req['X-API-Key'] = ENV['ORBIT_API_KEY']


res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts res.body

PHP

<?php
$ch = curl_init('https://api.orbit.devotel.io/api/v1/whatsapp/test-account/analytics');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  'X-API-Key: ' . getenv('ORBIT_API_KEY'),

]);

echo curl_exec($ch);

{
  "data": {
    "kpis": {
      "sent": 128,
      "delivered": 121,
      "read": 87
    },
    "daily": [
      { "date": "2026-08-29", "sent": 6, "delivered": 6 },
      { "date": "2026-08-30", "sent": 4, "delivered": 4 }
    ]
  },
  "meta": {
    "request_id": "req_wa_stats",
    "timestamp": "2026-08-30T12:02:00.000Z"
  }
}

SDK surface bridge — Send the anchored demo message, page its reply index, or pull the alias-index snapshot — everything against the sandbox key.

These three tabs mirror SDK status and coverage. Python fronts client.request, Go fronts client.Request, and TS fronts fetch-TS — each with the sandbox key.

Send the anchored demo message

fetch-TS (Node SDK style)

const res = await fetch('https://api.orbit.devotel.io/api/v1/whatsapp/messages/wa_demo/request', {
  method: 'POST',
  headers: {
'X-API-Key': process.env.ORBIT_SANDBOX_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
  "to": "+14155552671",
  "type": "text"
},
})
console.log(await res.json())

client.request

r = requests.post("https://api.orbit.devotel.io/api/v1/whatsapp/messages/wa_demo/request", json={
  "to": "+14155552671",
  "type": "text"
}, headers={ "X-API-Key": os.environ["ORBIT_SANDBOX_KEY"] })
print(r.json())

client.Request

package main

import (
	"bytes"
	"net/http"
	"os"
)

func main() {
	req, _ := http.NewRequest("POST", "https://api.orbit.devotel.io/api/v1/whatsapp/messages/wa_demo/request", bytes.NewBuffer([]byte(`{
  "to": "+14155552671",
  "type": "text"
}`)))
	req.Header.Set("X-API-Key", os.Getenv("ORBIT_SANDBOX_KEY"))
	req.Header.Set("Content-Type", "application/json")
	http.DefaultClient.Do(req)
}

Alias a demo thread

fetch-TS (Node SDK style)

const res = await fetch('https://api.orbit.devotel.io/api/v1/whatsapp/messages/wa_demo/alias', {
  method: 'POST',
  headers: {
'X-API-Key': process.env.ORBIT_SANDBOX_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
  "lane": "alias"
},
})
console.log(await res.json())

client.request

r = requests.post("https://api.orbit.devotel.io/api/v1/whatsapp/messages/wa_demo/alias", json={
  "lane": "alias"
}, headers={ "X-API-Key": os.environ["ORBIT_SANDBOX_KEY"] })
print(r.json())

client.Request

package main

import (
	"bytes"
	"net/http"
	"os"
)

func main() {
	req, _ := http.NewRequest("POST", "https://api.orbit.devotel.io/api/v1/whatsapp/messages/wa_demo/alias", bytes.NewBuffer([]byte(`{
  "lane": "alias"
}`)))
	req.Header.Set("X-API-Key", os.Getenv("ORBIT_SANDBOX_KEY"))
	req.Header.Set("Content-Type", "application/json")
	http.DefaultClient.Do(req)
}

Read the alias index

fetch-TS (Node SDK style)

const res = await fetch('https://api.orbit.devotel.io/api/v1/whatsapp/messages/wa_demo/alias-index', {
  method: 'GET',
  headers: {
'X-API-Key': process.env.ORBIT_SANDBOX_KEY!,
  },
})
console.log(await res.json())

client.request

r = requests.get("https://api.orbit.devotel.io/api/v1/whatsapp/messages/wa_demo/alias-index", headers={ "X-API-Key": os.environ["ORBIT_SANDBOX_KEY"] })
print(r.json())

client.Request

package main

import (
	"bytes"
	"net/http"
	"os"
)

func main() {
	req, _ := http.NewRequest("GET", "https://api.orbit.devotel.io/api/v1/whatsapp/messages/wa_demo/alias-index", nil)
	req.Header.Set("X-API-Key", os.Getenv("ORBIT_SANDBOX_KEY"))
	http.DefaultClient.Do(req)
}

List costs

GET /api/v1/whatsapp/analytics/costs

string (enum: true|false)

Sandbox opt-in for Clerk-session-authenticated requests. Set to true to route the call through the test-mode pipeline: no real provider delivery, no credits deducted, response meta.test_mode: true. Ignored for live API keys (dv_live_sk_*) — server-to-server clients must use a test-prefixed key (dv_test_sk_*) to exercise sandbox. Test-prefixed keys unconditionally enable sandbox regardless of this header.

cURL

curl -X GET "https://api.orbit.devotel.io/api/v1/whatsapp/analytics/costs" \
  -H "X-API-Key: dv_live_sk_your_key_here" 

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/whatsapp/analytics/costs', {
  method: 'GET',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
  },
})
console.log(await res.json())

Python

import os, requests

headers = {"X-API-Key": os.environ["ORBIT_API_KEY"]}
r = requests.get("https://api.orbit.devotel.io/api/v1/whatsapp/analytics/costs", headers=headers)
print(r.json())

package main

import (
	"bytes"
	"net/http"
	"os"
)

func main() {
	req, _ := http.NewRequest("GET", "https://api.orbit.devotel.io/api/v1/whatsapp/analytics/costs", nil)
	req.Header.Set("X-API-Key", os.Getenv("ORBIT_API_KEY"))

	http.DefaultClient.Do(req)
}

Ruby

require 'net/http'
require 'json'

uri = URI('https://api.orbit.devotel.io/api/v1/whatsapp/analytics/costs')
req = Net::HTTP::Get.new(uri)
req['X-API-Key'] = ENV['ORBIT_API_KEY']


res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts res.body

PHP

<?php
$ch = curl_init('https://api.orbit.devotel.io/api/v1/whatsapp/analytics/costs');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  'X-API-Key: ' . getenv('ORBIT_API_KEY'),

]);

echo curl_exec($ch);

{
  "data": {
    "enable_welcome_message": true,
    "prompts": [
      "Track my order",
      "Talk to support",
      "See opening hours"
    ],
    "commands": [
      {
        "command_name": "order_status",
        "command_description": "Check where your order is"
      },
      {
        "command_name": "support",
        "command_description": "Open a support conversation"
      }
    ]
  },
  "meta": {
    "request_id": "req_wa_ca_get",
    "timestamp": "2026-08-30T12:00:00.000Z"
  }
}

List templates

GET /api/v1/whatsapp/analytics/templates

string (enum: true|false)

cURL

curl -X GET "https://api.orbit.devotel.io/api/v1/whatsapp/analytics/templates" \
  -H "X-API-Key: dv_live_sk_your_key_here" 

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/whatsapp/analytics/templates', {
  method: 'GET',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
  },
})
console.log(await res.json())

Python

import os, requests

headers = {"X-API-Key": os.environ["ORBIT_API_KEY"]}
r = requests.get("https://api.orbit.devotel.io/api/v1/whatsapp/analytics/templates", headers=headers)
print(r.json())

package main

import (
	"bytes"
	"net/http"
	"os"
)

func main() {
	req, _ := http.NewRequest("GET", "https://api.orbit.devotel.io/api/v1/whatsapp/analytics/templates", nil)
	req.Header.Set("X-API-Key", os.Getenv("ORBIT_API_KEY"))

	http.DefaultClient.Do(req)
}

Ruby

require 'net/http'
require 'json'

uri = URI('https://api.orbit.devotel.io/api/v1/whatsapp/analytics/templates')
req = Net::HTTP::Get.new(uri)
req['X-API-Key'] = ENV['ORBIT_API_KEY']


res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts res.body

PHP

<?php
$ch = curl_init('https://api.orbit.devotel.io/api/v1/whatsapp/analytics/templates');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  'X-API-Key: ' . getenv('ORBIT_API_KEY'),

]);

echo curl_exec($ch);

{
  "data": {
    "enable_welcome_message": true,
    "prompts": [
      "Track my order",
      "Talk to support",
      "See opening hours"
    ],
    "commands": [
      {
        "command_name": "order_status",
        "command_description": "Check where your order is"
      },
      {
        "command_name": "support",
        "command_description": "Open a support conversation"
      }
    ]
  },
  "meta": {
    "request_id": "req_wa_ca_get",
    "timestamp": "2026-08-30T12:00:00.000Z"
  }
}

List block-users

GET /api/v1/whatsapp/block-users

string (enum: true|false)

cURL

curl -X GET "https://api.orbit.devotel.io/api/v1/whatsapp/block-users" \
  -H "X-API-Key: dv_live_sk_your_key_here" 

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/whatsapp/block-users', {
  method: 'GET',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
  },
})
console.log(await res.json())

Python

import os, requests

headers = {"X-API-Key": os.environ["ORBIT_API_KEY"]}
r = requests.get("https://api.orbit.devotel.io/api/v1/whatsapp/block-users", headers=headers)
print(r.json())

package main

import (
	"bytes"
	"net/http"
	"os"
)

func main() {
	req, _ := http.NewRequest("GET", "https://api.orbit.devotel.io/api/v1/whatsapp/block-users", nil)
	req.Header.Set("X-API-Key", os.Getenv("ORBIT_API_KEY"))

	http.DefaultClient.Do(req)
}

Ruby

require 'net/http'
require 'json'

uri = URI('https://api.orbit.devotel.io/api/v1/whatsapp/block-users')
req = Net::HTTP::Get.new(uri)
req['X-API-Key'] = ENV['ORBIT_API_KEY']


res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts res.body

PHP

<?php
$ch = curl_init('https://api.orbit.devotel.io/api/v1/whatsapp/block-users');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  'X-API-Key: ' . getenv('ORBIT_API_KEY'),

]);

echo curl_exec($ch);

{
  "data": {
    "enable_welcome_message": true,
    "prompts": [
      "Track my order",
      "Talk to support",
      "See opening hours"
    ],
    "commands": [
      {
        "command_name": "order_status",
        "command_description": "Check where your order is"
      },
      {
        "command_name": "support",
        "command_description": "Open a support conversation"
      }
    ]
  },
  "meta": {
    "request_id": "req_wa_ca_get",
    "timestamp": "2026-08-30T12:00:00.000Z"
  }
}

List business-profile

GET /api/v1/whatsapp/business-profile

string (enum: true|false)

cURL

curl -X GET "https://api.orbit.devotel.io/api/v1/whatsapp/business-profile" \
  -H "X-API-Key: dv_live_sk_your_key_here" 

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/whatsapp/business-profile', {
  method: 'GET',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
  },
})
console.log(await res.json())

Python

import os, requests

headers = {"X-API-Key": os.environ["ORBIT_API_KEY"]}
r = requests.get("https://api.orbit.devotel.io/api/v1/whatsapp/business-profile", headers=headers)
print(r.json())

package main

import (
	"bytes"
	"net/http"
	"os"
)

func main() {
	req, _ := http.NewRequest("GET", "https://api.orbit.devotel.io/api/v1/whatsapp/business-profile", nil)
	req.Header.Set("X-API-Key", os.Getenv("ORBIT_API_KEY"))

	http.DefaultClient.Do(req)
}

Ruby

require 'net/http'
require 'json'

uri = URI('https://api.orbit.devotel.io/api/v1/whatsapp/business-profile')
req = Net::HTTP::Get.new(uri)
req['X-API-Key'] = ENV['ORBIT_API_KEY']


res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts res.body

PHP

<?php
$ch = curl_init('https://api.orbit.devotel.io/api/v1/whatsapp/business-profile');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  'X-API-Key: ' . getenv('ORBIT_API_KEY'),

]);

echo curl_exec($ch);

{
  "data": {
    "enable_welcome_message": true,
    "prompts": [
      "Track my order",
      "Talk to support",
      "See opening hours"
    ],
    "commands": [
      {
        "command_name": "order_status",
        "command_description": "Check where your order is"
      },
      {
        "command_name": "support",
        "command_description": "Open a support conversation"
      }
    ]
  },
  "meta": {
    "request_id": "req_wa_ca_get",
    "timestamp": "2026-08-30T12:00:00.000Z"
  }
}

List catalogs

GET /api/v1/whatsapp/businesses/{businessId}/catalogs

string

required

—

string (enum: true|false)

cURL

curl -X GET "https://api.orbit.devotel.io/api/v1/whatsapp/businesses/{businessId}/catalogs" \
  -H "X-API-Key: dv_live_sk_your_key_here" 

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/whatsapp/businesses/{businessId}/catalogs', {
  method: 'GET',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
  },
})
console.log(await res.json())

Python

import os, requests

headers = {"X-API-Key": os.environ["ORBIT_API_KEY"]}
r = requests.get("https://api.orbit.devotel.io/api/v1/whatsapp/businesses/{businessId}/catalogs", headers=headers)
print(r.json())

package main

import (
	"bytes"
	"net/http"
	"os"
)

func main() {
	req, _ := http.NewRequest("GET", "https://api.orbit.devotel.io/api/v1/whatsapp/businesses/{businessId}/catalogs", nil)
	req.Header.Set("X-API-Key", os.Getenv("ORBIT_API_KEY"))

	http.DefaultClient.Do(req)
}

Ruby

require 'net/http'
require 'json'

uri = URI('https://api.orbit.devotel.io/api/v1/whatsapp/businesses/{businessId}/catalogs')
req = Net::HTTP::Get.new(uri)
req['X-API-Key'] = ENV['ORBIT_API_KEY']


res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts res.body

PHP

<?php
$ch = curl_init('https://api.orbit.devotel.io/api/v1/whatsapp/businesses/{businessId}/catalogs');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  'X-API-Key: ' . getenv('ORBIT_API_KEY'),

]);

echo curl_exec($ch);

{
  "data": {
    "enable_welcome_message": true,
    "prompts": [
      "Track my order",
      "Talk to support",
      "See opening hours"
    ],
    "commands": [
      {
        "command_name": "order_status",
        "command_description": "Check where your order is"
      },
      {
        "command_name": "support",
        "command_description": "Open a support conversation"
      }
    ]
  },
  "meta": {
    "request_id": "req_wa_ca_get",
    "timestamp": "2026-08-30T12:00:00.000Z"
  }
}

List permissions

GET /api/v1/whatsapp/calling/permissions

string (enum: true|false)

cURL

curl -X GET "https://api.orbit.devotel.io/api/v1/whatsapp/calling/permissions" \
  -H "X-API-Key: dv_live_sk_your_key_here" 

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/whatsapp/calling/permissions', {
  method: 'GET',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
  },
})
console.log(await res.json())

Python

import os, requests

headers = {"X-API-Key": os.environ["ORBIT_API_KEY"]}
r = requests.get("https://api.orbit.devotel.io/api/v1/whatsapp/calling/permissions", headers=headers)
print(r.json())

package main

import (
	"bytes"
	"net/http"
	"os"
)

func main() {
	req, _ := http.NewRequest("GET", "https://api.orbit.devotel.io/api/v1/whatsapp/calling/permissions", nil)
	req.Header.Set("X-API-Key", os.Getenv("ORBIT_API_KEY"))

	http.DefaultClient.Do(req)
}

Ruby

require 'net/http'
require 'json'

uri = URI('https://api.orbit.devotel.io/api/v1/whatsapp/calling/permissions')
req = Net::HTTP::Get.new(uri)
req['X-API-Key'] = ENV['ORBIT_API_KEY']


res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts res.body

PHP

<?php
$ch = curl_init('https://api.orbit.devotel.io/api/v1/whatsapp/calling/permissions');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  'X-API-Key: ' . getenv('ORBIT_API_KEY'),

]);

echo curl_exec($ch);

{
  "data": {
    "enable_welcome_message": true,
    "prompts": [
      "Track my order",
      "Talk to support",
      "See opening hours"
    ],
    "commands": [
      {
        "command_name": "order_status",
        "command_description": "Check where your order is"
      },
      {
        "command_name": "support",
        "command_description": "Open a support conversation"
      }
    ]
  },
  "meta": {
    "request_id": "req_wa_ca_get",
    "timestamp": "2026-08-30T12:00:00.000Z"
  }
}

List catalog

GET /api/v1/whatsapp/catalog

string (enum: true|false)

cURL

curl -X GET "https://api.orbit.devotel.io/api/v1/whatsapp/catalog" \
  -H "X-API-Key: dv_live_sk_your_key_here" 

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/whatsapp/catalog', {
  method: 'GET',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
  },
})
console.log(await res.json())

Python

import os, requests

headers = {"X-API-Key": os.environ["ORBIT_API_KEY"]}
r = requests.get("https://api.orbit.devotel.io/api/v1/whatsapp/catalog", headers=headers)
print(r.json())

package main

import (
	"bytes"
	"net/http"
	"os"
)

func main() {
	req, _ := http.NewRequest("GET", "https://api.orbit.devotel.io/api/v1/whatsapp/catalog", nil)
	req.Header.Set("X-API-Key", os.Getenv("ORBIT_API_KEY"))

	http.DefaultClient.Do(req)
}

Ruby

require 'net/http'
require 'json'

uri = URI('https://api.orbit.devotel.io/api/v1/whatsapp/catalog')
req = Net::HTTP::Get.new(uri)
req['X-API-Key'] = ENV['ORBIT_API_KEY']


res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts res.body

PHP

<?php
$ch = curl_init('https://api.orbit.devotel.io/api/v1/whatsapp/catalog');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  'X-API-Key: ' . getenv('ORBIT_API_KEY'),

]);

echo curl_exec($ch);

{
  "data": {
    "enable_welcome_message": true,
    "prompts": [
      "Track my order",
      "Talk to support",
      "See opening hours"
    ],
    "commands": [
      {
        "command_name": "order_status",
        "command_description": "Check where your order is"
      },
      {
        "command_name": "support",
        "command_description": "Open a support conversation"
      }
    ]
  },
  "meta": {
    "request_id": "req_wa_ca_get",
    "timestamp": "2026-08-30T12:00:00.000Z"
  }
}

List catalogs

GET /api/v1/whatsapp/catalogs

string (enum: true|false)

cURL

curl -X GET "https://api.orbit.devotel.io/api/v1/whatsapp/catalogs" \
  -H "X-API-Key: dv_live_sk_your_key_here" 

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/whatsapp/catalogs', {
  method: 'GET',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
  },
})
console.log(await res.json())

Python

import os, requests

headers = {"X-API-Key": os.environ["ORBIT_API_KEY"]}
r = requests.get("https://api.orbit.devotel.io/api/v1/whatsapp/catalogs", headers=headers)
print(r.json())

package main

import (
	"bytes"
	"net/http"
	"os"
)

func main() {
	req, _ := http.NewRequest("GET", "https://api.orbit.devotel.io/api/v1/whatsapp/catalogs", nil)
	req.Header.Set("X-API-Key", os.Getenv("ORBIT_API_KEY"))

	http.DefaultClient.Do(req)
}

Ruby

require 'net/http'
require 'json'

uri = URI('https://api.orbit.devotel.io/api/v1/whatsapp/catalogs')
req = Net::HTTP::Get.new(uri)
req['X-API-Key'] = ENV['ORBIT_API_KEY']


res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts res.body

PHP

<?php
$ch = curl_init('https://api.orbit.devotel.io/api/v1/whatsapp/catalogs');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  'X-API-Key: ' . getenv('ORBIT_API_KEY'),

]);

echo curl_exec($ch);

{
  "data": {
    "enable_welcome_message": true,
    "prompts": [
      "Track my order",
      "Talk to support",
      "See opening hours"
    ],
    "commands": [
      {
        "command_name": "order_status",
        "command_description": "Check where your order is"
      },
      {
        "command_name": "support",
        "command_description": "Open a support conversation"
      }
    ]
  },
  "meta": {
    "request_id": "req_wa_ca_get",
    "timestamp": "2026-08-30T12:00:00.000Z"
  }
}

List products

GET /api/v1/whatsapp/catalogs/{catalogId}/products

string

required

—

string (enum: true|false)

cURL

curl -X GET "https://api.orbit.devotel.io/api/v1/whatsapp/catalogs/{catalogId}/products" \
  -H "X-API-Key: dv_live_sk_your_key_here" 

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/whatsapp/catalogs/{catalogId}/products', {
  method: 'GET',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
  },
})
console.log(await res.json())

Python

import os, requests

headers = {"X-API-Key": os.environ["ORBIT_API_KEY"]}
r = requests.get("https://api.orbit.devotel.io/api/v1/whatsapp/catalogs/{catalogId}/products", headers=headers)
print(r.json())

package main

import (
	"bytes"
	"net/http"
	"os"
)

func main() {
	req, _ := http.NewRequest("GET", "https://api.orbit.devotel.io/api/v1/whatsapp/catalogs/{catalogId}/products", nil)
	req.Header.Set("X-API-Key", os.Getenv("ORBIT_API_KEY"))

	http.DefaultClient.Do(req)
}

Ruby

require 'net/http'
require 'json'

uri = URI('https://api.orbit.devotel.io/api/v1/whatsapp/catalogs/{catalogId}/products')
req = Net::HTTP::Get.new(uri)
req['X-API-Key'] = ENV['ORBIT_API_KEY']


res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts res.body

PHP

<?php
$ch = curl_init('https://api.orbit.devotel.io/api/v1/whatsapp/catalogs/{catalogId}/products');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  'X-API-Key: ' . getenv('ORBIT_API_KEY'),

]);

echo curl_exec($ch);

{
  "data": {
    "enable_welcome_message": true,
    "prompts": [
      "Track my order",
      "Talk to support",
      "See opening hours"
    ],
    "commands": [
      {
        "command_name": "order_status",
        "command_description": "Check where your order is"
      },
      {
        "command_name": "support",
        "command_description": "Open a support conversation"
      }
    ]
  },
  "meta": {
    "request_id": "req_wa_ca_get",
    "timestamp": "2026-08-30T12:00:00.000Z"
  }
}

List connections

GET /api/v1/whatsapp/connections

string (enum: true|false)

cURL

curl -X GET "https://api.orbit.devotel.io/api/v1/whatsapp/connections" \
  -H "X-API-Key: dv_live_sk_your_key_here" 

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/whatsapp/connections', {
  method: 'GET',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
  },
})
console.log(await res.json())

Python

import os, requests

headers = {"X-API-Key": os.environ["ORBIT_API_KEY"]}
r = requests.get("https://api.orbit.devotel.io/api/v1/whatsapp/connections", headers=headers)
print(r.json())

package main

import (
	"bytes"
	"net/http"
	"os"
)

func main() {
	req, _ := http.NewRequest("GET", "https://api.orbit.devotel.io/api/v1/whatsapp/connections", nil)
	req.Header.Set("X-API-Key", os.Getenv("ORBIT_API_KEY"))

	http.DefaultClient.Do(req)
}

Ruby

require 'net/http'
require 'json'

uri = URI('https://api.orbit.devotel.io/api/v1/whatsapp/connections')
req = Net::HTTP::Get.new(uri)
req['X-API-Key'] = ENV['ORBIT_API_KEY']


res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts res.body

PHP

<?php
$ch = curl_init('https://api.orbit.devotel.io/api/v1/whatsapp/connections');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  'X-API-Key: ' . getenv('ORBIT_API_KEY'),

]);

echo curl_exec($ch);

{
  "data": {
    "enable_welcome_message": true,
    "prompts": [
      "Track my order",
      "Talk to support",
      "See opening hours"
    ],
    "commands": [
      {
        "command_name": "order_status",
        "command_description": "Check where your order is"
      },
      {
        "command_name": "support",
        "command_description": "Open a support conversation"
      }
    ]
  },
  "meta": {
    "request_id": "req_wa_ca_get",
    "timestamp": "2026-08-30T12:00:00.000Z"
  }
}

List calling

GET /api/v1/whatsapp/connections/{phoneNumberId}/calling

string

required

—

string (enum: true|false)

cURL

curl -X GET "https://api.orbit.devotel.io/api/v1/whatsapp/connections/{phoneNumberId}/calling" \
  -H "X-API-Key: dv_live_sk_your_key_here" 

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/whatsapp/connections/{phoneNumberId}/calling', {
  method: 'GET',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
  },
})
console.log(await res.json())

Python

import os, requests

headers = {"X-API-Key": os.environ["ORBIT_API_KEY"]}
r = requests.get("https://api.orbit.devotel.io/api/v1/whatsapp/connections/{phoneNumberId}/calling", headers=headers)
print(r.json())

package main

import (
	"bytes"
	"net/http"
	"os"
)

func main() {
	req, _ := http.NewRequest("GET", "https://api.orbit.devotel.io/api/v1/whatsapp/connections/{phoneNumberId}/calling", nil)
	req.Header.Set("X-API-Key", os.Getenv("ORBIT_API_KEY"))

	http.DefaultClient.Do(req)
}

Ruby

require 'net/http'
require 'json'

uri = URI('https://api.orbit.devotel.io/api/v1/whatsapp/connections/{phoneNumberId}/calling')
req = Net::HTTP::Get.new(uri)
req['X-API-Key'] = ENV['ORBIT_API_KEY']


res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts res.body

PHP

<?php
$ch = curl_init('https://api.orbit.devotel.io/api/v1/whatsapp/connections/{phoneNumberId}/calling');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  'X-API-Key: ' . getenv('ORBIT_API_KEY'),

]);

echo curl_exec($ch);

{
  "data": {
    "enable_welcome_message": true,
    "prompts": [
      "Track my order",
      "Talk to support",
      "See opening hours"
    ],
    "commands": [
      {
        "command_name": "order_status",
        "command_description": "Check where your order is"
      },
      {
        "command_name": "support",
        "command_description": "Open a support conversation"
      }
    ]
  },
  "meta": {
    "request_id": "req_wa_ca_get",
    "timestamp": "2026-08-30T12:00:00.000Z"
  }
}

List exists

GET /api/v1/whatsapp/connections/exists

string (enum: true|false)

cURL

curl -X GET "https://api.orbit.devotel.io/api/v1/whatsapp/connections/exists" \
  -H "X-API-Key: dv_live_sk_your_key_here" 

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/whatsapp/connections/exists', {
  method: 'GET',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
  },
})
console.log(await res.json())

Python

import os, requests

headers = {"X-API-Key": os.environ["ORBIT_API_KEY"]}
r = requests.get("https://api.orbit.devotel.io/api/v1/whatsapp/connections/exists", headers=headers)
print(r.json())

package main

import (
	"bytes"
	"net/http"
	"os"
)

func main() {
	req, _ := http.NewRequest("GET", "https://api.orbit.devotel.io/api/v1/whatsapp/connections/exists", nil)
	req.Header.Set("X-API-Key", os.Getenv("ORBIT_API_KEY"))

	http.DefaultClient.Do(req)
}

Ruby

require 'net/http'
require 'json'

uri = URI('https://api.orbit.devotel.io/api/v1/whatsapp/connections/exists')
req = Net::HTTP::Get.new(uri)
req['X-API-Key'] = ENV['ORBIT_API_KEY']


res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts res.body

PHP

<?php
$ch = curl_init('https://api.orbit.devotel.io/api/v1/whatsapp/connections/exists');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  'X-API-Key: ' . getenv('ORBIT_API_KEY'),

]);

echo curl_exec($ch);

{
  "data": {
    "enable_welcome_message": true,
    "prompts": [
      "Track my order",
      "Talk to support",
      "See opening hours"
    ],
    "commands": [
      {
        "command_name": "order_status",
        "command_description": "Check where your order is"
      },
      {
        "command_name": "support",
        "command_description": "Open a support conversation"
      }
    ]
  },
  "meta": {
    "request_id": "req_wa_ca_get",
    "timestamp": "2026-08-30T12:00:00.000Z"
  }
}

List conversational-automation

GET /api/v1/whatsapp/conversational-automation

string (enum: true|false)

cURL

curl -X GET "https://api.orbit.devotel.io/api/v1/whatsapp/conversational-automation" \
  -H "X-API-Key: dv_live_sk_your_key_here" 

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/whatsapp/conversational-automation', {
  method: 'GET',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
  },
})
console.log(await res.json())

Python

import os, requests

headers = {"X-API-Key": os.environ["ORBIT_API_KEY"]}
r = requests.get("https://api.orbit.devotel.io/api/v1/whatsapp/conversational-automation", headers=headers)
print(r.json())

package main

import (
	"bytes"
	"net/http"
	"os"
)

func main() {
	req, _ := http.NewRequest("GET", "https://api.orbit.devotel.io/api/v1/whatsapp/conversational-automation", nil)
	req.Header.Set("X-API-Key", os.Getenv("ORBIT_API_KEY"))

	http.DefaultClient.Do(req)
}

Ruby

require 'net/http'
require 'json'

uri = URI('https://api.orbit.devotel.io/api/v1/whatsapp/conversational-automation')
req = Net::HTTP::Get.new(uri)
req['X-API-Key'] = ENV['ORBIT_API_KEY']


res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts res.body

PHP

<?php
$ch = curl_init('https://api.orbit.devotel.io/api/v1/whatsapp/conversational-automation');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  'X-API-Key: ' . getenv('ORBIT_API_KEY'),

]);

echo curl_exec($ch);

{
  "data": {
    "enable_welcome_message": true,
    "prompts": [
      "Track my order",
      "Talk to support",
      "See opening hours"
    ],
    "commands": [
      {
        "command_name": "order_status",
        "command_description": "Check where your order is"
      },
      {
        "command_name": "support",
        "command_description": "Open a support conversation"
      }
    ]
  },
  "meta": {
    "request_id": "req_wa_ca_get",
    "timestamp": "2026-08-30T12:00:00.000Z"
  }
}

List search

GET /api/v1/whatsapp/conversations/search

string (enum: true|false)

cURL

curl -X GET "https://api.orbit.devotel.io/api/v1/whatsapp/conversations/search" \
  -H "X-API-Key: dv_live_sk_your_key_here" 

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/whatsapp/conversations/search', {
  method: 'GET',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
  },
})
console.log(await res.json())

Python

import os, requests

headers = {"X-API-Key": os.environ["ORBIT_API_KEY"]}
r = requests.get("https://api.orbit.devotel.io/api/v1/whatsapp/conversations/search", headers=headers)
print(r.json())

package main

import (
	"bytes"
	"net/http"
	"os"
)

func main() {
	req, _ := http.NewRequest("GET", "https://api.orbit.devotel.io/api/v1/whatsapp/conversations/search", nil)
	req.Header.Set("X-API-Key", os.Getenv("ORBIT_API_KEY"))

	http.DefaultClient.Do(req)
}

Ruby

require 'net/http'
require 'json'

uri = URI('https://api.orbit.devotel.io/api/v1/whatsapp/conversations/search')
req = Net::HTTP::Get.new(uri)
req['X-API-Key'] = ENV['ORBIT_API_KEY']


res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts res.body

PHP

<?php
$ch = curl_init('https://api.orbit.devotel.io/api/v1/whatsapp/conversations/search');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  'X-API-Key: ' . getenv('ORBIT_API_KEY'),

]);

echo curl_exec($ch);

{
  "data": {
    "enable_welcome_message": true,
    "prompts": [
      "Track my order",
      "Talk to support",
      "See opening hours"
    ],
    "commands": [
      {
        "command_name": "order_status",
        "command_description": "Check where your order is"
      },
      {
        "command_name": "support",
        "command_description": "Open a support conversation"
      }
    ]
  },
  "meta": {
    "request_id": "req_wa_ca_get",
    "timestamp": "2026-08-30T12:00:00.000Z"
  }
}

List flows

GET /api/v1/whatsapp/flows

string (enum: true|false)

cURL

curl -X GET "https://api.orbit.devotel.io/api/v1/whatsapp/flows" \
  -H "X-API-Key: dv_live_sk_your_key_here" 

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/whatsapp/flows', {
  method: 'GET',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
  },
})
console.log(await res.json())

Python

import os, requests

headers = {"X-API-Key": os.environ["ORBIT_API_KEY"]}
r = requests.get("https://api.orbit.devotel.io/api/v1/whatsapp/flows", headers=headers)
print(r.json())

package main

import (
	"bytes"
	"net/http"
	"os"
)

func main() {
	req, _ := http.NewRequest("GET", "https://api.orbit.devotel.io/api/v1/whatsapp/flows", nil)
	req.Header.Set("X-API-Key", os.Getenv("ORBIT_API_KEY"))

	http.DefaultClient.Do(req)
}

Ruby

require 'net/http'
require 'json'

uri = URI('https://api.orbit.devotel.io/api/v1/whatsapp/flows')
req = Net::HTTP::Get.new(uri)
req['X-API-Key'] = ENV['ORBIT_API_KEY']


res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |h| h.request(req) }
puts res.body

PHP

<?php
$ch = curl_init('https://api.orbit.devotel.io/api/v1/whatsapp/flows');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  'X-API-Key: ' . getenv('ORBIT_API_KEY'),

]);

echo curl_exec($ch);

{
  "data": {
    "enable_welcome_message": true,
    "prompts": [
      "Track my order",
      "Talk to support",
      "See opening hours"
    ],
    "commands": [
      {
        "command_name": "order_status",
        "command_description": "Check where your order is"
      },
      {
        "command_name": "support",
        "command_description": "Open a support conversation"
      }
    ]
  },
  "meta": {
    "request_id": "req_wa_ca_get",
    "timestamp": "2026-08-30T12:00:00.000Z"
  }
}

Get flows

GET /api/v1/whatsapp/flows/{flowId}

string

required

—

string (enum: true|false)

cURL

curl -X GET "https://api.orbit.devotel.io/api/v1/whatsapp/flows/{flowId}" \
  -H "X-API-Key: dv_live_sk_your_key_here" 

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/whatsapp/flows/{flowId}', {
  method: 'GET',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
  },
})
console.log(await res.json())

{
  "data": {
    "enable_welcome_message": true,
    "prompts": [
      "Track my order",
      "Talk to support",
      "See opening hours"
    ],
    "commands": [
      {
        "command_name": "order_status",
        "command_description": "Check where your order is"
      },
      {
        "command_name": "support",
        "command_description": "Open a support conversation"
      }
    ]
  },
  "meta": {
    "request_id": "req_wa_ca_get",
    "timestamp": "2026-08-30T12:00:00.000Z"
  }
}

List funnel

GET /api/v1/whatsapp/flows/{flowId}/funnel

string

required

—

string (enum: true|false)

cURL

curl -X GET "https://api.orbit.devotel.io/api/v1/whatsapp/flows/{flowId}/funnel" \
  -H "X-API-Key: dv_live_sk_your_key_here" 

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/whatsapp/flows/{flowId}/funnel', {
  method: 'GET',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
  },
})
console.log(await res.json())

{
  "data": {
    "enable_welcome_message": true,
    "prompts": [
      "Track my order",
      "Talk to support",
      "See opening hours"
    ],
    "commands": [
      {
        "command_name": "order_status",
        "command_description": "Check where your order is"
      },
      {
        "command_name": "support",
        "command_description": "Open a support conversation"
      }
    ]
  },
  "meta": {
    "request_id": "req_wa_ca_get",
    "timestamp": "2026-08-30T12:00:00.000Z"
  }
}

List submissions

GET /api/v1/whatsapp/flows/{flowId}/submissions

string

required

—

string (enum: true|false)

cURL

curl -X GET "https://api.orbit.devotel.io/api/v1/whatsapp/flows/{flowId}/submissions" \
  -H "X-API-Key: dv_live_sk_your_key_here" 

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/whatsapp/flows/{flowId}/submissions', {
  method: 'GET',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
  },
})
console.log(await res.json())

{
  "data": {
    "enable_welcome_message": true,
    "prompts": [
      "Track my order",
      "Talk to support",
      "See opening hours"
    ],
    "commands": [
      {
        "command_name": "order_status",
        "command_description": "Check where your order is"
      },
      {
        "command_name": "support",
        "command_description": "Open a support conversation"
      }
    ]
  },
  "meta": {
    "request_id": "req_wa_ca_get",
    "timestamp": "2026-08-30T12:00:00.000Z"
  }
}

List health

GET /api/v1/whatsapp/health

string (enum: true|false)

cURL

curl -X GET "https://api.orbit.devotel.io/api/v1/whatsapp/health" \
  -H "X-API-Key: dv_live_sk_your_key_here" 

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/whatsapp/health', {
  method: 'GET',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
  },
})
console.log(await res.json())

{
  "data": {
    "enable_welcome_message": true,
    "prompts": [
      "Track my order",
      "Talk to support",
      "See opening hours"
    ],
    "commands": [
      {
        "command_name": "order_status",
        "command_description": "Check where your order is"
      },
      {
        "command_name": "support",
        "command_description": "Open a support conversation"
      }
    ]
  },
  "meta": {
    "request_id": "req_wa_ca_get",
    "timestamp": "2026-08-30T12:00:00.000Z"
  }
}

List kb-config

GET /api/v1/whatsapp/kb-config

string (enum: true|false)

cURL

curl -X GET "https://api.orbit.devotel.io/api/v1/whatsapp/kb-config" \
  -H "X-API-Key: dv_live_sk_your_key_here" 

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/whatsapp/kb-config', {
  method: 'GET',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
  },
})
console.log(await res.json())

{
  "data": {
    "enable_welcome_message": true,
    "prompts": [
      "Track my order",
      "Talk to support",
      "See opening hours"
    ],
    "commands": [
      {
        "command_name": "order_status",
        "command_description": "Check where your order is"
      },
      {
        "command_name": "support",
        "command_description": "Open a support conversation"
      }
    ]
  },
  "meta": {
    "request_id": "req_wa_ca_get",
    "timestamp": "2026-08-30T12:00:00.000Z"
  }
}

Get media

GET /api/v1/whatsapp/media/{mediaId}

string

required

—

string (enum: true|false)

cURL

curl -X GET "https://api.orbit.devotel.io/api/v1/whatsapp/media/{mediaId}" \
  -H "X-API-Key: dv_live_sk_your_key_here" 

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/whatsapp/media/{mediaId}', {
  method: 'GET',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
  },
})
console.log(await res.json())

{
  "data": {
    "enable_welcome_message": true,
    "prompts": [
      "Track my order",
      "Talk to support",
      "See opening hours"
    ],
    "commands": [
      {
        "command_name": "order_status",
        "command_description": "Check where your order is"
      },
      {
        "command_name": "support",
        "command_description": "Open a support conversation"
      }
    ]
  },
  "meta": {
    "request_id": "req_wa_ca_get",
    "timestamp": "2026-08-30T12:00:00.000Z"
  }
}

List download

GET /api/v1/whatsapp/media/{mediaId}/download

string

required

—

string (enum: true|false)

cURL

curl -X GET "https://api.orbit.devotel.io/api/v1/whatsapp/media/{mediaId}/download" \
  -H "X-API-Key: dv_live_sk_your_key_here" 

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/whatsapp/media/{mediaId}/download', {
  method: 'GET',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
  },
})
console.log(await res.json())

{
  "data": {
    "enable_welcome_message": true,
    "prompts": [
      "Track my order",
      "Talk to support",
      "See opening hours"
    ],
    "commands": [
      {
        "command_name": "order_status",
        "command_description": "Check where your order is"
      },
      {
        "command_name": "support",
        "command_description": "Open a support conversation"
      }
    ]
  },
  "meta": {
    "request_id": "req_wa_ca_get",
    "timestamp": "2026-08-30T12:00:00.000Z"
  }
}

List phone-numbers

GET /api/v1/whatsapp/phone-numbers

string (enum: true|false)

cURL

curl -X GET "https://api.orbit.devotel.io/api/v1/whatsapp/phone-numbers" \
  -H "X-API-Key: dv_live_sk_your_key_here" 

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/whatsapp/phone-numbers', {
  method: 'GET',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
  },
})
console.log(await res.json())

{
  "data": {
    "enable_welcome_message": true,
    "prompts": [
      "Track my order",
      "Talk to support",
      "See opening hours"
    ],
    "commands": [
      {
        "command_name": "order_status",
        "command_description": "Check where your order is"
      },
      {
        "command_name": "support",
        "command_description": "Open a support conversation"
      }
    ]
  },
  "meta": {
    "request_id": "req_wa_ca_get",
    "timestamp": "2026-08-30T12:00:00.000Z"
  }
}

List pricing-analytics

GET /api/v1/whatsapp/pricing-analytics

string (enum: true|false)

cURL

curl -X GET "https://api.orbit.devotel.io/api/v1/whatsapp/pricing-analytics" \
  -H "X-API-Key: dv_live_sk_your_key_here" 

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/whatsapp/pricing-analytics', {
  method: 'GET',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
  },
})
console.log(await res.json())

{
  "data": {
    "enable_welcome_message": true,
    "prompts": [
      "Track my order",
      "Talk to support",
      "See opening hours"
    ],
    "commands": [
      {
        "command_name": "order_status",
        "command_description": "Check where your order is"
      },
      {
        "command_name": "support",
        "command_description": "Open a support conversation"
      }
    ]
  },
  "meta": {
    "request_id": "req_wa_ca_get",
    "timestamp": "2026-08-30T12:00:00.000Z"
  }
}

List quality

GET /api/v1/whatsapp/quality

string (enum: true|false)

cURL

curl -X GET "https://api.orbit.devotel.io/api/v1/whatsapp/quality" \
  -H "X-API-Key: dv_live_sk_your_key_here" 

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/whatsapp/quality', {
  method: 'GET',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
  },
})
console.log(await res.json())

{
  "data": {
    "enable_welcome_message": true,
    "prompts": [
      "Track my order",
      "Talk to support",
      "See opening hours"
    ],
    "commands": [
      {
        "command_name": "order_status",
        "command_description": "Check where your order is"
      },
      {
        "command_name": "support",
        "command_description": "Open a support conversation"
      }
    ]
  },
  "meta": {
    "request_id": "req_wa_ca_get",
    "timestamp": "2026-08-30T12:00:00.000Z"
  }
}

List status

GET /api/v1/whatsapp/status

string (enum: true|false)

cURL

curl -X GET "https://api.orbit.devotel.io/api/v1/whatsapp/status" \
  -H "X-API-Key: dv_live_sk_your_key_here" 

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/whatsapp/status', {
  method: 'GET',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
  },
})
console.log(await res.json())

{
  "data": {
    "enable_welcome_message": true,
    "prompts": [
      "Track my order",
      "Talk to support",
      "See opening hours"
    ],
    "commands": [
      {
        "command_name": "order_status",
        "command_description": "Check where your order is"
      },
      {
        "command_name": "support",
        "command_description": "Open a support conversation"
      }
    ]
  },
  "meta": {
    "request_id": "req_wa_ca_get",
    "timestamp": "2026-08-30T12:00:00.000Z"
  }
}

List templates

GET /api/v1/whatsapp/templates

string (enum: true|false)

cURL

curl -X GET "https://api.orbit.devotel.io/api/v1/whatsapp/templates" \
  -H "X-API-Key: dv_live_sk_your_key_here" 

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/whatsapp/templates', {
  method: 'GET',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
  },
})
console.log(await res.json())

{
  "data": {
    "enable_welcome_message": true,
    "prompts": [
      "Track my order",
      "Talk to support",
      "See opening hours"
    ],
    "commands": [
      {
        "command_name": "order_status",
        "command_description": "Check where your order is"
      },
      {
        "command_name": "support",
        "command_description": "Open a support conversation"
      }
    ]
  },
  "meta": {
    "request_id": "req_wa_ca_get",
    "timestamp": "2026-08-30T12:00:00.000Z"
  }
}

List library

GET /api/v1/whatsapp/templates/library

string (enum: true|false)

cURL

curl -X GET "https://api.orbit.devotel.io/api/v1/whatsapp/templates/library" \
  -H "X-API-Key: dv_live_sk_your_key_here" 

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/whatsapp/templates/library', {
  method: 'GET',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
  },
})
console.log(await res.json())

{
  "data": {
    "enable_welcome_message": true,
    "prompts": [
      "Track my order",
      "Talk to support",
      "See opening hours"
    ],
    "commands": [
      {
        "command_name": "order_status",
        "command_description": "Check where your order is"
      },
      {
        "command_name": "support",
        "command_description": "Open a support conversation"
      }
    ]
  },
  "meta": {
    "request_id": "req_wa_ca_get",
    "timestamp": "2026-08-30T12:00:00.000Z"
  }
}

List analytics

GET /api/v1/whatsapp/test-account/analytics

string (enum: true|false)

cURL

curl -X GET "https://api.orbit.devotel.io/api/v1/whatsapp/test-account/analytics" \
  -H "X-API-Key: dv_live_sk_your_key_here" 

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/whatsapp/test-account/analytics', {
  method: 'GET',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
  },
})
console.log(await res.json())

{
  "data": {
    "enable_welcome_message": true,
    "prompts": [
      "Track my order",
      "Talk to support",
      "See opening hours"
    ],
    "commands": [
      {
        "command_name": "order_status",
        "command_description": "Check where your order is"
      },
      {
        "command_name": "support",
        "command_description": "Open a support conversation"
      }
    ]
  },
  "meta": {
    "request_id": "req_wa_ca_get",
    "timestamp": "2026-08-30T12:00:00.000Z"
  }
}

List calling-availability

GET /api/v1/whatsapp/test-account/calling-availability

string (enum: true|false)

cURL

curl -X GET "https://api.orbit.devotel.io/api/v1/whatsapp/test-account/calling-availability" \
  -H "X-API-Key: dv_live_sk_your_key_here" 

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/whatsapp/test-account/calling-availability', {
  method: 'GET',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
  },
})
console.log(await res.json())

{
  "data": {
    "enable_welcome_message": true,
    "prompts": [
      "Track my order",
      "Talk to support",
      "See opening hours"
    ],
    "commands": [
      {
        "command_name": "order_status",
        "command_description": "Check where your order is"
      },
      {
        "command_name": "support",
        "command_description": "Open a support conversation"
      }
    ]
  },
  "meta": {
    "request_id": "req_wa_ca_get",
    "timestamp": "2026-08-30T12:00:00.000Z"
  }
}

List catalog

GET /api/v1/whatsapp/test-account/catalog

string (enum: true|false)

cURL

curl -X GET "https://api.orbit.devotel.io/api/v1/whatsapp/test-account/catalog" \
  -H "X-API-Key: dv_live_sk_your_key_here" 

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/whatsapp/test-account/catalog', {
  method: 'GET',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
  },
})
console.log(await res.json())

{
  "data": {
    "enable_welcome_message": true,
    "prompts": [
      "Track my order",
      "Talk to support",
      "See opening hours"
    ],
    "commands": [
      {
        "command_name": "order_status",
        "command_description": "Check where your order is"
      },
      {
        "command_name": "support",
        "command_description": "Open a support conversation"
      }
    ]
  },
  "meta": {
    "request_id": "req_wa_ca_get",
    "timestamp": "2026-08-30T12:00:00.000Z"
  }
}

List flows

GET /api/v1/whatsapp/test-account/flows

string (enum: true|false)

cURL

curl -X GET "https://api.orbit.devotel.io/api/v1/whatsapp/test-account/flows" \
  -H "X-API-Key: dv_live_sk_your_key_here" 

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/whatsapp/test-account/flows', {
  method: 'GET',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
  },
})
console.log(await res.json())

{
  "data": {
    "enable_welcome_message": true,
    "prompts": [
      "Track my order",
      "Talk to support",
      "See opening hours"
    ],
    "commands": [
      {
        "command_name": "order_status",
        "command_description": "Check where your order is"
      },
      {
        "command_name": "support",
        "command_description": "Open a support conversation"
      }
    ]
  },
  "meta": {
    "request_id": "req_wa_ca_get",
    "timestamp": "2026-08-30T12:00:00.000Z"
  }
}

List status

GET /api/v1/whatsapp/test-account/status

string (enum: true|false)

cURL

curl -X GET "https://api.orbit.devotel.io/api/v1/whatsapp/test-account/status" \
  -H "X-API-Key: dv_live_sk_your_key_here" 

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/whatsapp/test-account/status', {
  method: 'GET',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
  },
})
console.log(await res.json())

{
  "data": {
    "enable_welcome_message": true,
    "prompts": [
      "Track my order",
      "Talk to support",
      "See opening hours"
    ],
    "commands": [
      {
        "command_name": "order_status",
        "command_description": "Check where your order is"
      },
      {
        "command_name": "support",
        "command_description": "Open a support conversation"
      }
    ]
  },
  "meta": {
    "request_id": "req_wa_ca_get",
    "timestamp": "2026-08-30T12:00:00.000Z"
  }
}

List webhook

GET /api/v1/whatsapp/webhook

string (enum: true|false)

cURL

curl -X GET "https://api.orbit.devotel.io/api/v1/whatsapp/webhook" \
  -H "X-API-Key: dv_live_sk_your_key_here" 

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/whatsapp/webhook', {
  method: 'GET',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
  },
})
console.log(await res.json())

{
  "data": {
    "enable_welcome_message": true,
    "prompts": [
      "Track my order",
      "Talk to support",
      "See opening hours"
    ],
    "commands": [
      {
        "command_name": "order_status",
        "command_description": "Check where your order is"
      },
      {
        "command_name": "support",
        "command_description": "Open a support conversation"
      }
    ]
  },
  "meta": {
    "request_id": "req_wa_ca_get",
    "timestamp": "2026-08-30T12:00:00.000Z"
  }
}

Block-users whatsapp

POST /api/v1/whatsapp/block-users

string

Stripe-style idempotency token. Pass a stable, client-generated value (1-255 chars) to dedupe retries on transient timeouts. The same key+credential+path replays the original response for 24h on 2xx (5min on 4xx, 30s on 5xx). Returns 409 if a concurrent request with the same key is already in flight; replayed responses include the Idempotency-Replay: true response header.

string (enum: true|false)

cURL

curl -X POST "https://api.orbit.devotel.io/api/v1/whatsapp/block-users" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/whatsapp/block-users', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

{
  "data": {
    "enable_welcome_message": true,
    "prompts": [
      "Track my order",
      "Talk to support",
      "See opening hours"
    ],
    "commands": [
      {
        "command_name": "order_status",
        "command_description": "Check where your order is"
      },
      {
        "command_name": "support",
        "command_description": "Open a support conversation"
      }
    ]
  },
  "meta": {
    "request_id": "req_wa_ca_get",
    "timestamp": "2026-08-30T12:00:00.000Z"
  }
}

Picture business-profile

POST /api/v1/whatsapp/business-profile/picture

string

string (enum: true|false)

cURL

curl -X POST "https://api.orbit.devotel.io/api/v1/whatsapp/business-profile/picture" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/whatsapp/business-profile/picture', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

{
  "data": {
    "enable_welcome_message": true,
    "prompts": [
      "Track my order",
      "Talk to support",
      "See opening hours"
    ],
    "commands": [
      {
        "command_name": "order_status",
        "command_description": "Check where your order is"
      },
      {
        "command_name": "support",
        "command_description": "Open a support conversation"
      }
    ]
  },
  "meta": {
    "request_id": "req_wa_ca_get",
    "timestamp": "2026-08-30T12:00:00.000Z"
  }
}

Create accept

POST /api/v1/whatsapp/calling/calls/{metaCallId}/accept

string

required

—

string

string (enum: true|false)

cURL

curl -X POST "https://api.orbit.devotel.io/api/v1/whatsapp/calling/calls/{metaCallId}/accept" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/whatsapp/calling/calls/{metaCallId}/accept', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

{
  "data": {
    "enable_welcome_message": true,
    "prompts": [
      "Track my order",
      "Talk to support",
      "See opening hours"
    ],
    "commands": [
      {
        "command_name": "order_status",
        "command_description": "Check where your order is"
      },
      {
        "command_name": "support",
        "command_description": "Open a support conversation"
      }
    ]
  },
  "meta": {
    "request_id": "req_wa_ca_get",
    "timestamp": "2026-08-30T12:00:00.000Z"
  }
}

Create decline

POST /api/v1/whatsapp/calling/calls/{metaCallId}/decline

string

required

—

string

string (enum: true|false)

cURL

curl -X POST "https://api.orbit.devotel.io/api/v1/whatsapp/calling/calls/{metaCallId}/decline" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/whatsapp/calling/calls/{metaCallId}/decline', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

{
  "data": {
    "enable_welcome_message": true,
    "prompts": [
      "Track my order",
      "Talk to support",
      "See opening hours"
    ],
    "commands": [
      {
        "command_name": "order_status",
        "command_description": "Check where your order is"
      },
      {
        "command_name": "support",
        "command_description": "Open a support conversation"
      }
    ]
  },
  "meta": {
    "request_id": "req_wa_ca_get",
    "timestamp": "2026-08-30T12:00:00.000Z"
  }
}

Create accept

POST /api/v1/whatsapp/calls/{callId}/accept

string

required

—

string

string (enum: true|false)

cURL

curl -X POST "https://api.orbit.devotel.io/api/v1/whatsapp/calls/{callId}/accept" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/whatsapp/calls/{callId}/accept', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

{
  "data": {
    "enable_welcome_message": true,
    "prompts": [
      "Track my order",
      "Talk to support",
      "See opening hours"
    ],
    "commands": [
      {
        "command_name": "order_status",
        "command_description": "Check where your order is"
      },
      {
        "command_name": "support",
        "command_description": "Open a support conversation"
      }
    ]
  },
  "meta": {
    "request_id": "req_wa_ca_get",
    "timestamp": "2026-08-30T12:00:00.000Z"
  }
}

Create pre_accept

POST /api/v1/whatsapp/calls/{callId}/pre_accept

string

required

—

string

string (enum: true|false)

cURL

curl -X POST "https://api.orbit.devotel.io/api/v1/whatsapp/calls/{callId}/pre_accept" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/whatsapp/calls/{callId}/pre_accept', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

{
  "data": {
    "enable_welcome_message": true,
    "prompts": [
      "Track my order",
      "Talk to support",
      "See opening hours"
    ],
    "commands": [
      {
        "command_name": "order_status",
        "command_description": "Check where your order is"
      },
      {
        "command_name": "support",
        "command_description": "Open a support conversation"
      }
    ]
  },
  "meta": {
    "request_id": "req_wa_ca_get",
    "timestamp": "2026-08-30T12:00:00.000Z"
  }
}

Create reject

POST /api/v1/whatsapp/calls/{callId}/reject

string

required

—

string

string (enum: true|false)

cURL

curl -X POST "https://api.orbit.devotel.io/api/v1/whatsapp/calls/{callId}/reject" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/whatsapp/calls/{callId}/reject', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

{
  "data": {
    "enable_welcome_message": true,
    "prompts": [
      "Track my order",
      "Talk to support",
      "See opening hours"
    ],
    "commands": [
      {
        "command_name": "order_status",
        "command_description": "Check where your order is"
      },
      {
        "command_name": "support",
        "command_description": "Open a support conversation"
      }
    ]
  },
  "meta": {
    "request_id": "req_wa_ca_get",
    "timestamp": "2026-08-30T12:00:00.000Z"
  }
}

Create terminate

POST /api/v1/whatsapp/calls/{callId}/terminate

string

required

—

string

string (enum: true|false)

cURL

curl -X POST "https://api.orbit.devotel.io/api/v1/whatsapp/calls/{callId}/terminate" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/whatsapp/calls/{callId}/terminate', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

{
  "data": {
    "enable_welcome_message": true,
    "prompts": [
      "Track my order",
      "Talk to support",
      "See opening hours"
    ],
    "commands": [
      {
        "command_name": "order_status",
        "command_description": "Check where your order is"
      },
      {
        "command_name": "support",
        "command_description": "Open a support conversation"
      }
    ]
  },
  "meta": {
    "request_id": "req_wa_ca_get",
    "timestamp": "2026-08-30T12:00:00.000Z"
  }
}

Initiate calls

POST /api/v1/whatsapp/calls/initiate

string

string (enum: true|false)

cURL

curl -X POST "https://api.orbit.devotel.io/api/v1/whatsapp/calls/initiate" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/whatsapp/calls/initiate', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

{
  "data": {
    "enable_welcome_message": true,
    "prompts": [
      "Track my order",
      "Talk to support",
      "See opening hours"
    ],
    "commands": [
      {
        "command_name": "order_status",
        "command_description": "Check where your order is"
      },
      {
        "command_name": "support",
        "command_description": "Open a support conversation"
      }
    ]
  },
  "meta": {
    "request_id": "req_wa_ca_get",
    "timestamp": "2026-08-30T12:00:00.000Z"
  }
}

Permission calls

POST /api/v1/whatsapp/calls/permission

string

string (enum: true|false)

cURL

curl -X POST "https://api.orbit.devotel.io/api/v1/whatsapp/calls/permission" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/whatsapp/calls/permission', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

{
  "data": {
    "enable_welcome_message": true,
    "prompts": [
      "Track my order",
      "Talk to support",
      "See opening hours"
    ],
    "commands": [
      {
        "command_name": "order_status",
        "command_description": "Check where your order is"
      },
      {
        "command_name": "support",
        "command_description": "Open a support conversation"
      }
    ]
  },
  "meta": {
    "request_id": "req_wa_ca_get",
    "timestamp": "2026-08-30T12:00:00.000Z"
  }
}

Send catalog

POST /api/v1/whatsapp/catalog/send

string

string (enum: true|false)

cURL

curl -X POST "https://api.orbit.devotel.io/api/v1/whatsapp/catalog/send" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/whatsapp/catalog/send', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

{
  "data": {
    "enable_welcome_message": true,
    "prompts": [
      "Track my order",
      "Talk to support",
      "See opening hours"
    ],
    "commands": [
      {
        "command_name": "order_status",
        "command_description": "Check where your order is"
      },
      {
        "command_name": "support",
        "command_description": "Open a support conversation"
      }
    ]
  },
  "meta": {
    "request_id": "req_wa_ca_get",
    "timestamp": "2026-08-30T12:00:00.000Z"
  }
}

Send-list catalog

POST /api/v1/whatsapp/catalog/send-list

string

string (enum: true|false)

cURL

curl -X POST "https://api.orbit.devotel.io/api/v1/whatsapp/catalog/send-list" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/whatsapp/catalog/send-list', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

{
  "data": {
    "enable_welcome_message": true,
    "prompts": [
      "Track my order",
      "Talk to support",
      "See opening hours"
    ],
    "commands": [
      {
        "command_name": "order_status",
        "command_description": "Check where your order is"
      },
      {
        "command_name": "support",
        "command_description": "Open a support conversation"
      }
    ]
  },
  "meta": {
    "request_id": "req_wa_ca_get",
    "timestamp": "2026-08-30T12:00:00.000Z"
  }
}

Catalogs whatsapp

POST /api/v1/whatsapp/catalogs

string

string (enum: true|false)

cURL

curl -X POST "https://api.orbit.devotel.io/api/v1/whatsapp/catalogs" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/whatsapp/catalogs', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

{
  "data": {
    "enable_welcome_message": true,
    "prompts": [
      "Track my order",
      "Talk to support",
      "See opening hours"
    ],
    "commands": [
      {
        "command_name": "order_status",
        "command_description": "Check where your order is"
      },
      {
        "command_name": "support",
        "command_description": "Open a support conversation"
      }
    ]
  },
  "meta": {
    "request_id": "req_wa_ca_get",
    "timestamp": "2026-08-30T12:00:00.000Z"
  }
}

Create products

POST /api/v1/whatsapp/catalogs/{catalogId}/products

string

required

—

string

string (enum: true|false)

cURL

curl -X POST "https://api.orbit.devotel.io/api/v1/whatsapp/catalogs/{catalogId}/products" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/whatsapp/catalogs/{catalogId}/products', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

{
  "data": {
    "enable_welcome_message": true,
    "prompts": [
      "Track my order",
      "Talk to support",
      "See opening hours"
    ],
    "commands": [
      {
        "command_name": "order_status",
        "command_description": "Check where your order is"
      },
      {
        "command_name": "support",
        "command_description": "Open a support conversation"
      }
    ]
  },
  "meta": {
    "request_id": "req_wa_ca_get",
    "timestamp": "2026-08-30T12:00:00.000Z"
  }
}

Create send

POST /api/v1/whatsapp/catalogs/{catalogId}/send

string

required

—

string

string (enum: true|false)

cURL

curl -X POST "https://api.orbit.devotel.io/api/v1/whatsapp/catalogs/{catalogId}/send" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/whatsapp/catalogs/{catalogId}/send', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

{
  "data": {
    "enable_welcome_message": true,
    "prompts": [
      "Track my order",
      "Talk to support",
      "See opening hours"
    ],
    "commands": [
      {
        "command_name": "order_status",
        "command_description": "Check where your order is"
      },
      {
        "command_name": "support",
        "command_description": "Open a support conversation"
      }
    ]
  },
  "meta": {
    "request_id": "req_wa_ca_get",
    "timestamp": "2026-08-30T12:00:00.000Z"
  }
}

Connect whatsapp

POST /api/v1/whatsapp/connect

string

string (enum: true|false)

cURL

curl -X POST "https://api.orbit.devotel.io/api/v1/whatsapp/connect" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/whatsapp/connect', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

{
  "data": {
    "enable_welcome_message": true,
    "prompts": [
      "Track my order",
      "Talk to support",
      "See opening hours"
    ],
    "commands": [
      {
        "command_name": "order_status",
        "command_description": "Check where your order is"
      },
      {
        "command_name": "support",
        "command_description": "Open a support conversation"
      }
    ]
  },
  "meta": {
    "request_id": "req_wa_ca_get",
    "timestamp": "2026-08-30T12:00:00.000Z"
  }
}

Disable calling

POST /api/v1/whatsapp/connections/{phoneNumberId}/calling/disable

string

required

—

string

string (enum: true|false)

cURL

curl -X POST "https://api.orbit.devotel.io/api/v1/whatsapp/connections/{phoneNumberId}/calling/disable" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/whatsapp/connections/{phoneNumberId}/calling/disable', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

{
  "data": {
    "enable_welcome_message": true,
    "prompts": [
      "Track my order",
      "Talk to support",
      "See opening hours"
    ],
    "commands": [
      {
        "command_name": "order_status",
        "command_description": "Check where your order is"
      },
      {
        "command_name": "support",
        "command_description": "Open a support conversation"
      }
    ]
  },
  "meta": {
    "request_id": "req_wa_ca_get",
    "timestamp": "2026-08-30T12:00:00.000Z"
  }
}

Enable calling

POST /api/v1/whatsapp/connections/{phoneNumberId}/calling/enable

string

required

—

string

string (enum: true|false)

cURL

curl -X POST "https://api.orbit.devotel.io/api/v1/whatsapp/connections/{phoneNumberId}/calling/enable" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/whatsapp/connections/{phoneNumberId}/calling/enable', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

{
  "data": {
    "enable_welcome_message": true,
    "prompts": [
      "Track my order",
      "Talk to support",
      "See opening hours"
    ],
    "commands": [
      {
        "command_name": "order_status",
        "command_description": "Check where your order is"
      },
      {
        "command_name": "support",
        "command_description": "Open a support conversation"
      }
    ]
  },
  "meta": {
    "request_id": "req_wa_ca_get",
    "timestamp": "2026-08-30T12:00:00.000Z"
  }
}

Register-webhook calling

POST /api/v1/whatsapp/connections/{phoneNumberId}/calling/register-webhook

string

required

—

string

string (enum: true|false)

cURL

curl -X POST "https://api.orbit.devotel.io/api/v1/whatsapp/connections/{phoneNumberId}/calling/register-webhook" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/whatsapp/connections/{phoneNumberId}/calling/register-webhook', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

{
  "data": {
    "enable_welcome_message": true,
    "prompts": [
      "Track my order",
      "Talk to support",
      "See opening hours"
    ],
    "commands": [
      {
        "command_name": "order_status",
        "command_description": "Check where your order is"
      },
      {
        "command_name": "support",
        "command_description": "Open a support conversation"
      }
    ]
  },
  "meta": {
    "request_id": "req_wa_ca_get",
    "timestamp": "2026-08-30T12:00:00.000Z"
  }
}

Create archive

POST /api/v1/whatsapp/conversations/{conversationId}/archive

string

required

—

string

string (enum: true|false)

cURL

curl -X POST "https://api.orbit.devotel.io/api/v1/whatsapp/conversations/conv_8b2c4d6e1f/archive" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/whatsapp/conversations/conv_8b2c4d6e1f/archive', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

{
  "data": {
    "enable_welcome_message": true,
    "prompts": [
      "Track my order",
      "Talk to support",
      "See opening hours"
    ],
    "commands": [
      {
        "command_name": "order_status",
        "command_description": "Check where your order is"
      },
      {
        "command_name": "support",
        "command_description": "Open a support conversation"
      }
    ]
  },
  "meta": {
    "request_id": "req_wa_ca_get",
    "timestamp": "2026-08-30T12:00:00.000Z"
  }
}

Create read

POST /api/v1/whatsapp/conversations/{conversationId}/read

string

required

—

string

string (enum: true|false)

cURL

curl -X POST "https://api.orbit.devotel.io/api/v1/whatsapp/conversations/conv_8b2c4d6e1f/read" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/whatsapp/conversations/conv_8b2c4d6e1f/read', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

{
  "data": {
    "enable_welcome_message": true,
    "prompts": [
      "Track my order",
      "Talk to support",
      "See opening hours"
    ],
    "commands": [
      {
        "command_name": "order_status",
        "command_description": "Check where your order is"
      },
      {
        "command_name": "support",
        "command_description": "Open a support conversation"
      }
    ]
  },
  "meta": {
    "request_id": "req_wa_ca_get",
    "timestamp": "2026-08-30T12:00:00.000Z"
  }
}

Create resolve-bsuid

POST /api/v1/whatsapp/conversations/{conversationId}/resolve-bsuid

string

required

—

string

string (enum: true|false)

cURL

curl -X POST "https://api.orbit.devotel.io/api/v1/whatsapp/conversations/conv_8b2c4d6e1f/resolve-bsuid" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/whatsapp/conversations/conv_8b2c4d6e1f/resolve-bsuid', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

{
  "data": {
    "enable_welcome_message": true,
    "prompts": [
      "Track my order",
      "Talk to support",
      "See opening hours"
    ],
    "commands": [
      {
        "command_name": "order_status",
        "command_description": "Check where your order is"
      },
      {
        "command_name": "support",
        "command_description": "Open a support conversation"
      }
    ]
  },
  "meta": {
    "request_id": "req_wa_ca_get",
    "timestamp": "2026-08-30T12:00:00.000Z"
  }
}

Estimate WhatsApp marketing campaign cost

POST /api/v1/whatsapp/cost-optimizer/estimate

Estimate a WhatsApp MARKETING campaign’s Meta conversation cost from the two variables that drive it: the number of recipients and their country. Returns the per-recipient marketing rate and projected spend. Pure planning — does NOT send anything.

string

string (enum: true|false)

integer

required

Number of recipients the marketing campaign will reach.

string

ISO-3166 alpha-2 target country (e.g. “BR”). Omitted → Meta’s default rate card.

cURL

curl -X POST "https://api.orbit.devotel.io/api/v1/whatsapp/cost-optimizer/estimate" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{
  "recipientCount": 0
}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/whatsapp/cost-optimizer/estimate', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
  "recipientCount": 0
}),
})
console.log(await res.json())

{
  "data": {
    "enable_welcome_message": true,
    "prompts": [
      "Track my order",
      "Talk to support",
      "See opening hours"
    ],
    "commands": [
      {
        "command_name": "order_status",
        "command_description": "Check where your order is"
      },
      {
        "command_name": "support",
        "command_description": "Open a support conversation"
      }
    ]
  },
  "meta": {
    "request_id": "req_wa_ca_get",
    "timestamp": "2026-08-30T12:00:00.000Z"
  }
}

Plan WhatsApp campaign cost optimization

POST /api/v1/whatsapp/cost-optimizer/plan

Pre-send conversation-cost optimizer: cheapest-category selection + utility-before-marketing sequencing + per-campaign budget guard. Returns a projected-spend + savings report. Pure planning — does NOT send anything.

string

string (enum: true|false)

number

Optional total campaign budget (USD). Sends beyond it are deferred.

object[]

required

—

cURL

curl -X POST "https://api.orbit.devotel.io/api/v1/whatsapp/cost-optimizer/plan" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{
  "sends": []
}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/whatsapp/cost-optimizer/plan', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
  "sends": []
}),
})
console.log(await res.json())

{
  "data": {
    "enable_welcome_message": true,
    "prompts": [
      "Track my order",
      "Talk to support",
      "See opening hours"
    ],
    "commands": [
      {
        "command_name": "order_status",
        "command_description": "Check where your order is"
      },
      {
        "command_name": "support",
        "command_description": "Open a support conversation"
      }
    ]
  },
  "meta": {
    "request_id": "req_wa_ca_get",
    "timestamp": "2026-08-30T12:00:00.000Z"
  }
}

Flows whatsapp

POST /api/v1/whatsapp/flows

string

string (enum: true|false)

cURL

curl -X POST "https://api.orbit.devotel.io/api/v1/whatsapp/flows" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/whatsapp/flows', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

{
  "data": {
    "enable_welcome_message": true,
    "prompts": [
      "Track my order",
      "Talk to support",
      "See opening hours"
    ],
    "commands": [
      {
        "command_name": "order_status",
        "command_description": "Check where your order is"
      },
      {
        "command_name": "support",
        "command_description": "Open a support conversation"
      }
    ]
  },
  "meta": {
    "request_id": "req_wa_ca_get",
    "timestamp": "2026-08-30T12:00:00.000Z"
  }
}

Create assets

POST /api/v1/whatsapp/flows/{flowId}/assets

string

required

—

string

string (enum: true|false)

cURL

curl -X POST "https://api.orbit.devotel.io/api/v1/whatsapp/flows/{flowId}/assets" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/whatsapp/flows/{flowId}/assets', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

{
  "data": {
    "enable_welcome_message": true,
    "prompts": [
      "Track my order",
      "Talk to support",
      "See opening hours"
    ],
    "commands": [
      {
        "command_name": "order_status",
        "command_description": "Check where your order is"
      },
      {
        "command_name": "support",
        "command_description": "Open a support conversation"
      }
    ]
  },
  "meta": {
    "request_id": "req_wa_ca_get",
    "timestamp": "2026-08-30T12:00:00.000Z"
  }
}

Create publish

POST /api/v1/whatsapp/flows/{flowId}/publish

string

required

—

string

string (enum: true|false)

cURL

curl -X POST "https://api.orbit.devotel.io/api/v1/whatsapp/flows/{flowId}/publish" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/whatsapp/flows/{flowId}/publish', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

{
  "data": {
    "enable_welcome_message": true,
    "prompts": [
      "Track my order",
      "Talk to support",
      "See opening hours"
    ],
    "commands": [
      {
        "command_name": "order_status",
        "command_description": "Check where your order is"
      },
      {
        "command_name": "support",
        "command_description": "Open a support conversation"
      }
    ]
  },
  "meta": {
    "request_id": "req_wa_ca_get",
    "timestamp": "2026-08-30T12:00:00.000Z"
  }
}

Generate flows

POST /api/v1/whatsapp/flows/generate

string

string (enum: true|false)

cURL

curl -X POST "https://api.orbit.devotel.io/api/v1/whatsapp/flows/generate" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/whatsapp/flows/generate', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

{
  "data": {
    "enable_welcome_message": true,
    "prompts": [
      "Track my order",
      "Talk to support",
      "See opening hours"
    ],
    "commands": [
      {
        "command_name": "order_status",
        "command_description": "Check where your order is"
      },
      {
        "command_name": "support",
        "command_description": "Open a support conversation"
      }
    ]
  },
  "meta": {
    "request_id": "req_wa_ca_get",
    "timestamp": "2026-08-30T12:00:00.000Z"
  }
}

Kb-config whatsapp

POST /api/v1/whatsapp/kb-config

string

string (enum: true|false)

cURL

curl -X POST "https://api.orbit.devotel.io/api/v1/whatsapp/kb-config" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/whatsapp/kb-config', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

{
  "data": {
    "enable_welcome_message": true,
    "prompts": [
      "Track my order",
      "Talk to support",
      "See opening hours"
    ],
    "commands": [
      {
        "command_name": "order_status",
        "command_description": "Check where your order is"
      },
      {
        "command_name": "support",
        "command_description": "Open a support conversation"
      }
    ]
  },
  "meta": {
    "request_id": "req_wa_ca_get",
    "timestamp": "2026-08-30T12:00:00.000Z"
  }
}

Send WhatsApp marketing message

POST /api/v1/whatsapp/marketing-messages/send

Send a MARKETING-category template via Meta’s Marketing Messages API (MM Lite) for send-time/creative optimization. Reuses the tenant’s connected WABA token. tracking_id correlates status webhooks back to a campaign/journey.

string

string (enum: true|false)

string

required

Recipient E.164 phone number.

string

required

Approved marketing template name.

string

required

Template language code (e.g. en_US).

object[]

Meta template components (header/body/buttons).

string

Echoed on status webhooks for campaign/CTR correlation.

string

Optional WABA selector for multi-WABA tenants.

cURL

curl -X POST "https://api.orbit.devotel.io/api/v1/whatsapp/marketing-messages/send" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{
  "to": "+14155552671",
  "template_name": "string",
  "language_code": "string"
}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/whatsapp/marketing-messages/send', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
  "to": "+14155552671",
  "template_name": "string",
  "language_code": "string"
}),
})
console.log(await res.json())

{
  "data": {
    "enable_welcome_message": true,
    "prompts": [
      "Track my order",
      "Talk to support",
      "See opening hours"
    ],
    "commands": [
      {
        "command_name": "order_status",
        "command_description": "Check where your order is"
      },
      {
        "command_name": "support",
        "command_description": "Open a support conversation"
      }
    ]
  },
  "meta": {
    "request_id": "req_wa_ca_get",
    "timestamp": "2026-08-30T12:00:00.000Z"
  }
}

Create read

POST /api/v1/whatsapp/messages/{messageId}/read

string

required

—

string

string (enum: true|false)

cURL

curl -X POST "https://api.orbit.devotel.io/api/v1/whatsapp/messages/{messageId}/read" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/whatsapp/messages/{messageId}/read', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

{
  "data": {
    "enable_welcome_message": true,
    "prompts": [
      "Track my order",
      "Talk to support",
      "See opening hours"
    ],
    "commands": [
      {
        "command_name": "order_status",
        "command_description": "Check where your order is"
      },
      {
        "command_name": "support",
        "command_description": "Open a support conversation"
      }
    ]
  },
  "meta": {
    "request_id": "req_wa_ca_get",
    "timestamp": "2026-08-30T12:00:00.000Z"
  }
}

Send WhatsApp address-request message

POST /api/v1/whatsapp/messages/send-address-request

Prompt the recipient to submit (or pick a saved) structured delivery address, inside the 24h customer-service window — no template review required. country (ISO 3166-1 alpha-2) selects the field set Meta renders. The reply arrives as an address_message interactive reply on the inbound webhook.

string

string (enum: true|false)

string

required

Recipient E.164 phone number OR WhatsApp Business Solution UID.

string

required

Prompt text shown above the address form (1-1024 chars).

string

required

ISO 3166-1 alpha-2 country code selecting Meta’s address field set (e.g. IN, SG).

object

Optional pre-fill values keyed by Meta’s per-country field names.

object[]

Optional previously-saved addresses the recipient can pick from, in markets that support it.

cURL

curl -X POST "https://api.orbit.devotel.io/api/v1/whatsapp/messages/send-address-request" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{
  "to": "+14155552671",
  "body": "string",
  "country": "string"
}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/whatsapp/messages/send-address-request', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
  "to": "+14155552671",
  "body": "string",
  "country": "string"
}),
})
console.log(await res.json())

{
  "data": {
    "enable_welcome_message": true,
    "prompts": [
      "Track my order",
      "Talk to support",
      "See opening hours"
    ],
    "commands": [
      {
        "command_name": "order_status",
        "command_description": "Check where your order is"
      },
      {
        "command_name": "support",
        "command_description": "Open a support conversation"
      }
    ]
  },
  "meta": {
    "request_id": "req_wa_ca_get",
    "timestamp": "2026-08-30T12:00:00.000Z"
  }
}

Send-flow messages

POST /api/v1/whatsapp/messages/send-flow

string

string (enum: true|false)

cURL

curl -X POST "https://api.orbit.devotel.io/api/v1/whatsapp/messages/send-flow" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/whatsapp/messages/send-flow', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

{
  "data": {
    "enable_welcome_message": true,
    "prompts": [
      "Track my order",
      "Talk to support",
      "See opening hours"
    ],
    "commands": [
      {
        "command_name": "order_status",
        "command_description": "Check where your order is"
      },
      {
        "command_name": "support",
        "command_description": "Open a support conversation"
      }
    ]
  },
  "meta": {
    "request_id": "req_wa_ca_get",
    "timestamp": "2026-08-30T12:00:00.000Z"
  }
}

Send WhatsApp interactive message

POST /api/v1/whatsapp/messages/send-interactive

Send an interactive WhatsApp message (reply-buttons, list-menu, or a CTA-URL button) inside the 24h customer-service window — no template review required. The recipient’s tap on a reply-button/list returns as button_reply/list_reply on the inbound webhook; a CTA-URL tap opens the link directly. action is one of (max 3 reply buttons), (list menu, max 10 sections × 10 rows), or (a single labelled https link button).

string

string (enum: true|false)

string

required

Recipient E.164 phone number OR WhatsApp Business Solution UID.

string

Optional short header text (max 60 chars).

string

required

Message body text (1-1024 chars).

string

Optional footer text (max 60 chars).

object

required

Reply-buttons () OR list-menu () OR a CTA-URL button ().

cURL

curl -X POST "https://api.orbit.devotel.io/api/v1/whatsapp/messages/send-interactive" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{
  "to": "+14155552671",
  "body": "string",
  "action": {}
}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/whatsapp/messages/send-interactive', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
  "to": "+14155552671",
  "body": "string",
  "action": {}
}),
})
console.log(await res.json())

{
  "data": {
    "enable_welcome_message": true,
    "prompts": [
      "Track my order",
      "Talk to support",
      "See opening hours"
    ],
    "commands": [
      {
        "command_name": "order_status",
        "command_description": "Check where your order is"
      },
      {
        "command_name": "support",
        "command_description": "Open a support conversation"
      }
    ]
  },
  "meta": {
    "request_id": "req_wa_ca_get",
    "timestamp": "2026-08-30T12:00:00.000Z"
  }
}

Send WhatsApp location-request message

POST /api/v1/whatsapp/messages/send-location-request

Prompt the recipient to share their current location via a ‘Send location’ button, inside the 24h customer-service window — no template review required. The reply arrives as a plain location message on the inbound webhook.

string

string (enum: true|false)

string

required

Recipient E.164 phone number OR WhatsApp Business Solution UID.

string

required

Prompt text shown above the ‘Send location’ button (1-1024 chars).

cURL

curl -X POST "https://api.orbit.devotel.io/api/v1/whatsapp/messages/send-location-request" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{
  "to": "+14155552671",
  "body": "string"
}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/whatsapp/messages/send-location-request', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
  "to": "+14155552671",
  "body": "string"
}),
})
console.log(await res.json())

{
  "data": {
    "enable_welcome_message": true,
    "prompts": [
      "Track my order",
      "Talk to support",
      "See opening hours"
    ],
    "commands": [
      {
        "command_name": "order_status",
        "command_description": "Check where your order is"
      },
      {
        "command_name": "support",
        "command_description": "Open a support conversation"
      }
    ]
  },
  "meta": {
    "request_id": "req_wa_ca_get",
    "timestamp": "2026-08-30T12:00:00.000Z"
  }
}

Request-code phone

POST /api/v1/whatsapp/phone/request-code

string

string (enum: true|false)

cURL

curl -X POST "https://api.orbit.devotel.io/api/v1/whatsapp/phone/request-code" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/whatsapp/phone/request-code', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

{
  "data": {
    "enable_welcome_message": true,
    "prompts": [
      "Track my order",
      "Talk to support",
      "See opening hours"
    ],
    "commands": [
      {
        "command_name": "order_status",
        "command_description": "Check where your order is"
      },
      {
        "command_name": "support",
        "command_description": "Open a support conversation"
      }
    ]
  },
  "meta": {
    "request_id": "req_wa_ca_get",
    "timestamp": "2026-08-30T12:00:00.000Z"
  }
}

Verify-code phone

POST /api/v1/whatsapp/phone/verify-code

string

string (enum: true|false)

cURL

curl -X POST "https://api.orbit.devotel.io/api/v1/whatsapp/phone/verify-code" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/whatsapp/phone/verify-code', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

{
  "data": {
    "enable_welcome_message": true,
    "prompts": [
      "Track my order",
      "Talk to support",
      "See opening hours"
    ],
    "commands": [
      {
        "command_name": "order_status",
        "command_description": "Check where your order is"
      },
      {
        "command_name": "support",
        "command_description": "Open a support conversation"
      }
    ]
  },
  "meta": {
    "request_id": "req_wa_ca_get",
    "timestamp": "2026-08-30T12:00:00.000Z"
  }
}

Create edit

POST /api/v1/whatsapp/templates/{externalId}/edit

string

required

—

string

string (enum: true|false)

cURL

curl -X POST "https://api.orbit.devotel.io/api/v1/whatsapp/templates/{externalId}/edit" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/whatsapp/templates/{externalId}/edit', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

{
  "data": {
    "enable_welcome_message": true,
    "prompts": [
      "Track my order",
      "Talk to support",
      "See opening hours"
    ],
    "commands": [
      {
        "command_name": "order_status",
        "command_description": "Check where your order is"
      },
      {
        "command_name": "support",
        "command_description": "Open a support conversation"
      }
    ]
  },
  "meta": {
    "request_id": "req_wa_ca_get",
    "timestamp": "2026-08-30T12:00:00.000Z"
  }
}

Generate templates

POST /api/v1/whatsapp/templates/generate

string

string (enum: true|false)

cURL

curl -X POST "https://api.orbit.devotel.io/api/v1/whatsapp/templates/generate" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/whatsapp/templates/generate', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

{
  "data": {
    "enable_welcome_message": true,
    "prompts": [
      "Track my order",
      "Talk to support",
      "See opening hours"
    ],
    "commands": [
      {
        "command_name": "order_status",
        "command_description": "Check where your order is"
      },
      {
        "command_name": "support",
        "command_description": "Open a support conversation"
      }
    ]
  },
  "meta": {
    "request_id": "req_wa_ca_get",
    "timestamp": "2026-08-30T12:00:00.000Z"
  }
}

Library templates

POST /api/v1/whatsapp/templates/library

string

string (enum: true|false)

cURL

curl -X POST "https://api.orbit.devotel.io/api/v1/whatsapp/templates/library" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/whatsapp/templates/library', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

{
  "data": {
    "enable_welcome_message": true,
    "prompts": [
      "Track my order",
      "Talk to support",
      "See opening hours"
    ],
    "commands": [
      {
        "command_name": "order_status",
        "command_description": "Check where your order is"
      },
      {
        "command_name": "support",
        "command_description": "Open a support conversation"
      }
    ]
  },
  "meta": {
    "request_id": "req_wa_ca_get",
    "timestamp": "2026-08-30T12:00:00.000Z"
  }
}

Sync templates

POST /api/v1/whatsapp/templates/sync

string

string (enum: true|false)

cURL

curl -X POST "https://api.orbit.devotel.io/api/v1/whatsapp/templates/sync" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/whatsapp/templates/sync', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

{
  "data": {
    "enable_welcome_message": true,
    "prompts": [
      "Track my order",
      "Talk to support",
      "See opening hours"
    ],
    "commands": [
      {
        "command_name": "order_status",
        "command_description": "Check where your order is"
      },
      {
        "command_name": "support",
        "command_description": "Open a support conversation"
      }
    ]
  },
  "meta": {
    "request_id": "req_wa_ca_get",
    "timestamp": "2026-08-30T12:00:00.000Z"
  }
}

Change-number test-account

POST /api/v1/whatsapp/test-account/change-number

string

string (enum: true|false)

cURL

curl -X POST "https://api.orbit.devotel.io/api/v1/whatsapp/test-account/change-number" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/whatsapp/test-account/change-number', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

{
  "data": {
    "enable_welcome_message": true,
    "prompts": [
      "Track my order",
      "Talk to support",
      "See opening hours"
    ],
    "commands": [
      {
        "command_name": "order_status",
        "command_description": "Check where your order is"
      },
      {
        "command_name": "support",
        "command_description": "Open a support conversation"
      }
    ]
  },
  "meta": {
    "request_id": "req_wa_ca_get",
    "timestamp": "2026-08-30T12:00:00.000Z"
  }
}

Clear-verification test-account

POST /api/v1/whatsapp/test-account/clear-verification

string

string (enum: true|false)

cURL

curl -X POST "https://api.orbit.devotel.io/api/v1/whatsapp/test-account/clear-verification" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/whatsapp/test-account/clear-verification', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

{
  "data": {
    "enable_welcome_message": true,
    "prompts": [
      "Track my order",
      "Talk to support",
      "See opening hours"
    ],
    "commands": [
      {
        "command_name": "order_status",
        "command_description": "Check where your order is"
      },
      {
        "command_name": "support",
        "command_description": "Open a support conversation"
      }
    ]
  },
  "meta": {
    "request_id": "req_wa_ca_get",
    "timestamp": "2026-08-30T12:00:00.000Z"
  }
}

Send-otp test-account

POST /api/v1/whatsapp/test-account/send-otp

string

string (enum: true|false)

cURL

curl -X POST "https://api.orbit.devotel.io/api/v1/whatsapp/test-account/send-otp" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/whatsapp/test-account/send-otp', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

{
  "data": {
    "enable_welcome_message": true,
    "prompts": [
      "Track my order",
      "Talk to support",
      "See opening hours"
    ],
    "commands": [
      {
        "command_name": "order_status",
        "command_description": "Check where your order is"
      },
      {
        "command_name": "support",
        "command_description": "Open a support conversation"
      }
    ]
  },
  "meta": {
    "request_id": "req_wa_ca_get",
    "timestamp": "2026-08-30T12:00:00.000Z"
  }
}

Verify-otp test-account

POST /api/v1/whatsapp/test-account/verify-otp

string

string (enum: true|false)

cURL

curl -X POST "https://api.orbit.devotel.io/api/v1/whatsapp/test-account/verify-otp" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/whatsapp/test-account/verify-otp', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

{
  "data": {
    "enable_welcome_message": true,
    "prompts": [
      "Track my order",
      "Talk to support",
      "See opening hours"
    ],
    "commands": [
      {
        "command_name": "order_status",
        "command_description": "Check where your order is"
      },
      {
        "command_name": "support",
        "command_description": "Open a support conversation"
      }
    ]
  },
  "meta": {
    "request_id": "req_wa_ca_get",
    "timestamp": "2026-08-30T12:00:00.000Z"
  }
}

Unblock-users whatsapp

POST /api/v1/whatsapp/unblock-users

string

string (enum: true|false)

cURL

curl -X POST "https://api.orbit.devotel.io/api/v1/whatsapp/unblock-users" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/whatsapp/unblock-users', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

{
  "data": {
    "enable_welcome_message": true,
    "prompts": [
      "Track my order",
      "Talk to support",
      "See opening hours"
    ],
    "commands": [
      {
        "command_name": "order_status",
        "command_description": "Check where your order is"
      },
      {
        "command_name": "support",
        "command_description": "Open a support conversation"
      }
    ]
  },
  "meta": {
    "request_id": "req_wa_ca_get",
    "timestamp": "2026-08-30T12:00:00.000Z"
  }
}

Webhook whatsapp

POST /api/v1/whatsapp/webhook

string

string (enum: true|false)

cURL

curl -X POST "https://api.orbit.devotel.io/api/v1/whatsapp/webhook" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/whatsapp/webhook', {
  method: 'POST',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

{
  "data": {
    "enable_welcome_message": true,
    "prompts": [
      "Track my order",
      "Talk to support",
      "See opening hours"
    ],
    "commands": [
      {
        "command_name": "order_status",
        "command_description": "Check where your order is"
      },
      {
        "command_name": "support",
        "command_description": "Open a support conversation"
      }
    ]
  },
  "meta": {
    "request_id": "req_wa_ca_get",
    "timestamp": "2026-08-30T12:00:00.000Z"
  }
}

Update business-profile

PUT /api/v1/whatsapp/business-profile

string

string (enum: true|false)

cURL

curl -X PUT "https://api.orbit.devotel.io/api/v1/whatsapp/business-profile" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/whatsapp/business-profile', {
  method: 'PUT',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

{
  "data": {
    "enable_welcome_message": true,
    "prompts": [
      "Track my order",
      "Talk to support",
      "See opening hours"
    ],
    "commands": [
      {
        "command_name": "order_status",
        "command_description": "Check where your order is"
      },
      {
        "command_name": "support",
        "command_description": "Open a support conversation"
      }
    ]
  },
  "meta": {
    "request_id": "req_wa_ca_get",
    "timestamp": "2026-08-30T12:00:00.000Z"
  }
}

Update default

PUT /api/v1/whatsapp/connections/{phoneNumberId}/default

string

required

—

string

string (enum: true|false)

cURL

curl -X PUT "https://api.orbit.devotel.io/api/v1/whatsapp/connections/{phoneNumberId}/default" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/whatsapp/connections/{phoneNumberId}/default', {
  method: 'PUT',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

{
  "data": {
    "enable_welcome_message": true,
    "prompts": [
      "Track my order",
      "Talk to support",
      "See opening hours"
    ],
    "commands": [
      {
        "command_name": "order_status",
        "command_description": "Check where your order is"
      },
      {
        "command_name": "support",
        "command_description": "Open a support conversation"
      }
    ]
  },
  "meta": {
    "request_id": "req_wa_ca_get",
    "timestamp": "2026-08-30T12:00:00.000Z"
  }
}

Update conversational-automation

PUT /api/v1/whatsapp/conversational-automation

string

string (enum: true|false)

cURL

curl -X PUT "https://api.orbit.devotel.io/api/v1/whatsapp/conversational-automation" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/whatsapp/conversational-automation', {
  method: 'PUT',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

{
  "data": {
    "enable_welcome_message": true,
    "prompts": [
      "Track my order",
      "Talk to support",
      "See opening hours"
    ],
    "commands": [
      {
        "command_name": "order_status",
        "command_description": "Check where your order is"
      },
      {
        "command_name": "support",
        "command_description": "Open a support conversation"
      }
    ]
  },
  "meta": {
    "request_id": "req_wa_ca_get",
    "timestamp": "2026-08-30T12:00:00.000Z"
  }
}

Update products

PUT /api/v1/whatsapp/products/{productId}

string

required

—

string

string (enum: true|false)

cURL

curl -X PUT "https://api.orbit.devotel.io/api/v1/whatsapp/products/{productId}" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/whatsapp/products/{productId}', {
  method: 'PUT',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

{
  "data": {
    "enable_welcome_message": true,
    "prompts": [
      "Track my order",
      "Talk to support",
      "See opening hours"
    ],
    "commands": [
      {
        "command_name": "order_status",
        "command_description": "Check where your order is"
      },
      {
        "command_name": "support",
        "command_description": "Open a support conversation"
      }
    ]
  },
  "meta": {
    "request_id": "req_wa_ca_get",
    "timestamp": "2026-08-30T12:00:00.000Z"
  }
}

Patch connections

PATCH /api/v1/whatsapp/connections/{phoneNumberId}

string

required

—

string (enum: true|false)

cURL

curl -X PATCH "https://api.orbit.devotel.io/api/v1/whatsapp/connections/{phoneNumberId}" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/whatsapp/connections/{phoneNumberId}', {
  method: 'PATCH',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

{
  "data": {
    "enable_welcome_message": true,
    "prompts": [
      "Track my order",
      "Talk to support",
      "See opening hours"
    ],
    "commands": [
      {
        "command_name": "order_status",
        "command_description": "Check where your order is"
      },
      {
        "command_name": "support",
        "command_description": "Open a support conversation"
      }
    ]
  },
  "meta": {
    "request_id": "req_wa_ca_get",
    "timestamp": "2026-08-30T12:00:00.000Z"
  }
}

Delete catalogs

DELETE /api/v1/whatsapp/catalogs/{catalogId}

string

required

—

string (enum: true|false)

cURL

curl -X DELETE "https://api.orbit.devotel.io/api/v1/whatsapp/catalogs/{catalogId}" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/whatsapp/catalogs/{catalogId}', {
  method: 'DELETE',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

{
  "data": {
    "enable_welcome_message": true,
    "prompts": [
      "Track my order",
      "Talk to support",
      "See opening hours"
    ],
    "commands": [
      {
        "command_name": "order_status",
        "command_description": "Check where your order is"
      },
      {
        "command_name": "support",
        "command_description": "Open a support conversation"
      }
    ]
  },
  "meta": {
    "request_id": "req_wa_ca_get",
    "timestamp": "2026-08-30T12:00:00.000Z"
  }
}

Delete connections

DELETE /api/v1/whatsapp/connections/{phoneNumberId}

string

required

—

string (enum: true|false)

cURL

curl -X DELETE "https://api.orbit.devotel.io/api/v1/whatsapp/connections/{phoneNumberId}" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/whatsapp/connections/{phoneNumberId}', {
  method: 'DELETE',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

{
  "data": {
    "enable_welcome_message": true,
    "prompts": [
      "Track my order",
      "Talk to support",
      "See opening hours"
    ],
    "commands": [
      {
        "command_name": "order_status",
        "command_description": "Check where your order is"
      },
      {
        "command_name": "support",
        "command_description": "Open a support conversation"
      }
    ]
  },
  "meta": {
    "request_id": "req_wa_ca_get",
    "timestamp": "2026-08-30T12:00:00.000Z"
  }
}

Delete disconnect

DELETE /api/v1/whatsapp/disconnect

string (enum: true|false)

cURL

curl -X DELETE "https://api.orbit.devotel.io/api/v1/whatsapp/disconnect" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/whatsapp/disconnect', {
  method: 'DELETE',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

{
  "data": {
    "enable_welcome_message": true,
    "prompts": [
      "Track my order",
      "Talk to support",
      "See opening hours"
    ],
    "commands": [
      {
        "command_name": "order_status",
        "command_description": "Check where your order is"
      },
      {
        "command_name": "support",
        "command_description": "Open a support conversation"
      }
    ]
  },
  "meta": {
    "request_id": "req_wa_ca_get",
    "timestamp": "2026-08-30T12:00:00.000Z"
  }
}

Delete flows

DELETE /api/v1/whatsapp/flows/{flowId}

string

required

—

string (enum: true|false)

cURL

curl -X DELETE "https://api.orbit.devotel.io/api/v1/whatsapp/flows/{flowId}" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/whatsapp/flows/{flowId}', {
  method: 'DELETE',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

{
  "data": {
    "enable_welcome_message": true,
    "prompts": [
      "Track my order",
      "Talk to support",
      "See opening hours"
    ],
    "commands": [
      {
        "command_name": "order_status",
        "command_description": "Check where your order is"
      },
      {
        "command_name": "support",
        "command_description": "Open a support conversation"
      }
    ]
  },
  "meta": {
    "request_id": "req_wa_ca_get",
    "timestamp": "2026-08-30T12:00:00.000Z"
  }
}

Delete products

DELETE /api/v1/whatsapp/products/{productId}

string

required

—

string (enum: true|false)

cURL

curl -X DELETE "https://api.orbit.devotel.io/api/v1/whatsapp/products/{productId}" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/whatsapp/products/{productId}', {
  method: 'DELETE',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

{
  "data": {
    "enable_welcome_message": true,
    "prompts": [
      "Track my order",
      "Talk to support",
      "See opening hours"
    ],
    "commands": [
      {
        "command_name": "order_status",
        "command_description": "Check where your order is"
      },
      {
        "command_name": "support",
        "command_description": "Open a support conversation"
      }
    ]
  },
  "meta": {
    "request_id": "req_wa_ca_get",
    "timestamp": "2026-08-30T12:00:00.000Z"
  }
}

Delete templates

DELETE /api/v1/whatsapp/templates/{name}

string

required

—

string (enum: true|false)

cURL

curl -X DELETE "https://api.orbit.devotel.io/api/v1/whatsapp/templates/{name}" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

Node.js

import { Orbit } from '@devotel-orbit/node'

const orbit = new Orbit({
  apiKey: process.env.ORBIT_API_KEY!,
})

const res = await fetch('https://api.orbit.devotel.io/api/v1/whatsapp/templates/{name}', {
  method: 'DELETE',
  headers: {
    'X-API-Key': process.env.ORBIT_API_KEY!,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
})
console.log(await res.json())

{
  "data": {
    "enable_welcome_message": true,
    "prompts": [
      "Track my order",
      "Talk to support",
      "See opening hours"
    ],
    "commands": [
      {
        "command_name": "order_status",
        "command_description": "Check where your order is"
      },
      {
        "command_name": "support",
        "command_description": "Open a support conversation"
      }
    ]
  },
  "meta": {
    "request_id": "req_wa_ca_get",
    "timestamp": "2026-08-30T12:00:00.000Z"
  }
}

​WhatsApp API

​title: “Worked samples” description: “Read → update → re-read the conversational-automation config (ice breakers, slash commands, welcome toggle), an interactive send with the full envelope, the test-account analytics envelope, and validation errors.”

​Worked request and response samples

​1. Read the conversational-automation config

​2. Update the config (full desired state)

​3. Send an interactive message

​4. Test-account analytics KPIs

​SDK surface bridge — Send the anchored demo message, page its reply index, or pull the alias-index snapshot — everything against the sandbox key.

​Send the anchored demo message

​Alias a demo thread

​Read the alias index

​List costs

​List templates

​List block-users

​List business-profile

​List catalogs

​List permissions

​List catalog

​List catalogs

​List products

​List connections

​List calling

​List exists

​List conversational-automation

​List search

​List flows

​Get flows

​List funnel

​List submissions

​List health

​List kb-config

​Get media

​List download

​List phone-numbers

​List pricing-analytics

​List quality

​List status

​List templates

​List library

​List analytics

​List calling-availability

​List catalog

​List flows

​List status

​List webhook

​Block-users whatsapp

​Picture business-profile

​Create accept

​Create decline

​Create accept

​Create pre_accept

​Create reject

​Create terminate

​Initiate calls

​Permission calls

​Send catalog

​Send-list catalog

​Catalogs whatsapp

​Create products

​Create send

​Connect whatsapp

​Disable calling

​Enable calling

​Register-webhook calling

​Create archive

​Create read

​Create resolve-bsuid

​Estimate WhatsApp marketing campaign cost

​Plan WhatsApp campaign cost optimization

​Flows whatsapp

​Create assets

​Create publish

​Generate flows

​Kb-config whatsapp

​Send WhatsApp marketing message

​Create read

​Send WhatsApp address-request message

​Send-flow messages

​Send WhatsApp interactive message

​Send WhatsApp location-request message

WhatsApp API

title: “Worked samples” description: “Read → update → re-read the conversational-automation config (ice breakers, slash commands, welcome toggle), an interactive send with the full envelope, the test-account analytics envelope, and validation errors.”

Worked request and response samples

1. Read the conversational-automation config

2. Update the config (full desired state)

3. Send an interactive message

4. Test-account analytics KPIs

SDK surface bridge — Send the anchored demo message, page its reply index, or pull the alias-index snapshot — everything against the sandbox key.

Send the anchored demo message

Alias a demo thread

Read the alias index

List costs

List templates

List block-users

List business-profile

List catalogs

List permissions

List catalog

List catalogs

List products

List connections

List calling

List exists

List conversational-automation

List search

List flows

Get flows

List funnel

List submissions

List health

List kb-config

Get media

List download

List phone-numbers

List pricing-analytics

List quality

List status

List templates

List library

List analytics

List calling-availability

List catalog

List flows

List status

List webhook

Block-users whatsapp

Picture business-profile

Create accept

Create decline

Create accept

Create pre_accept

Create reject

Create terminate

Initiate calls

Permission calls

Send catalog

Send-list catalog

Catalogs whatsapp

Create products

Create send

Connect whatsapp

Disable calling

Enable calling

Register-webhook calling

Create archive

Create read

Create resolve-bsuid

Estimate WhatsApp marketing campaign cost

Plan WhatsApp campaign cost optimization

Flows whatsapp

Create assets

Create publish

Generate flows

Kb-config whatsapp

Send WhatsApp marketing message

Create read

Send WhatsApp address-request message

Send-flow messages

Send WhatsApp interactive message

Send WhatsApp location-request message