{"info":{"_postman_id":"b0f8e61f-7a2d-488c-8c5b-2835b092a3f9","name":"Spoki API","description":"

Version 1 of the Spoki API is structured around REST, HTTP, and JSON. API endpoint URLs are organized around resources, such as contacts or templates. It uses HTTP methods for indicating the action to take on a resource, and HTTP status codes for expressing error states.

Installation

Use the Run in Postman button at the top right corner of this doc to import this collection into your local Postman app.

Base URL

The API is accessed using the following base URL: https://api.spoki.com/api/1/
\n
All endpoint paths must begin with /api/1, which specifies version 1 of the API.
\n
All API requests must be made over HTTPS.
\n

Schema

All API requests and response bodies adhere to a common JSON format representing individual items, collections of items, links to related items and additional meta data.

Single Resources

Individual resources are represented by top level member named after the resource in the singular form.

Collections

Collections of resources are represented by a top level member named after the resource in the plural form.

Environment

This collection includes a pre-configured environment.

To run requests in the Get Started guide, you need to set the variables in the following table to values that make sense for your business:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Description
Base-URL	https://api.spoki.com
Api-Key	You need an active Spoki account to get this key.
Service-Api-Key	You need an active Spoki account to get this key.
Your-Delivery-URL	The URL where Spoki will send you the webhook

Guidance

To ensure the best experience with using the ActiveCampaign APIs, please observe the following guidelines.

Use version 1 (v1) APIs.
\n
If an error occurs, please pause or “sleep” execution for at least 1,000 milliseconds before resubmitting your API request.
\n

We are actively working on improving our platform experience, adding new features, and improving performance. Following these guidelines will reduce intermittent errors and help us to provide a better experience for all customers.

Authentication

All requests to the API are authenticated by providing your API key. The API key must be provided as an HTTP header named X-Spoki-Api-Key.

Each Spoki account has his own unique API key.

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Installation","slug":"installation"},{"content":"Base URL","slug":"base-url"},{"content":"Schema","slug":"schema"},{"content":"Environment","slug":"environment"},{"content":"Guidance","slug":"guidance"},{"content":"Authentication","slug":"authentication"}],"owner":"21611004","collectionId":"b0f8e61f-7a2d-488c-8c5b-2835b092a3f9","publishedId":"UzBqnPvF","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"15D36B"},"publishDate":"2024-03-29T13:36:45.000Z"},"item":[{"name":"Accounts","item":[{"name":"List, search, and filter accounts","id":"e5945eaf-8d26-4d3c-9dbc-5a0b36d5b02e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{Base-URL}}/api/1/accounts/","description":"

Rate Limit: 5/min

This endpoint retrieves a list of accounts.

Response

The response will include an array of objects, where each object represents an account with the following properties:

id (number): The unique identifier for the account.
\n
name (string): The name associated with the account.
\n
current_credit (number): The current credit balance for the account.
\n
status (string): The status of the account.
\n
default_language (string): The default language set for the account.
\n
phone (string): The phone number associated with the account.
\n
has_official_verification (boolean): Indicates whether the account has official verification.
\n
daily_limit (number): The daily limit for the account.
\n
phone_status (string): The status for the phone.
\n
- 🟢 Connected
  \n
- 🟡 Flagged
  \n
- 🔴 Restricted
  \n
- 🚫 Banned
  \n
- 📵 Disconnected
  \n
- Ⓜ️ Migrated
  \n
- ⏳ Pending
  \n
- ⛔️ Rate limited
  \n
- ❗️ Unverified
  \n
\n
quality_score (number): The quality score of the account.
\n
- 1 : 🟢 Green
  \n
- 2 : 🟡 Yellow
  \n
- 3 : 🔴 Red
  \n
\n
quality_reasons (null): Reasons for the quality score (if available).
\n
is_active (boolean): Indicates whether the account is active.
\n
country_code (string): The country code associated with the account.
\n
estimated_available_conversations (number): The estimated available conversations for the account.
\n
account_type (number): The type of the account.
\n
- 1 : Sandbox
  \n
- 2 : Standard
  \n
- 4 : Agency
  \n
\n
default_pricing_delta (number): The default pricing delta for the account.
\n
low_credit_threshold (number): The low credit threshold for the account.
\n
has_low_credit_alert (boolean): Indicates whether the account has a low credit alert.
\n
default_prefix (string): The default prefix for the account.
\n
default_country_code (string): The default country code for the account.
\n
timezone (string): The timezone set for the account.
\n
contacted_in_24h (number): Number of contacts made in the last 24 hours for the account.
\n
contacted_in_7d (number): Number of contacts made in the last 7 days for the account.
\n
primary_channel_id (number | null): The ID of the primary channel associated with the account. null if no primary channel is set.
\n
channels (array): List of channels associated with the account. Each channel object follows the AccountChannel shape with the following 10 fields:
\n
- id (number): The unique identifier for the channel.
  \n
- name (string): The display name of the channel.
  \n
- phone (string): The phone number associated with the channel.
  \n
- phone_status (string): The connection status of the channel's phone number (same values as account-level phone_status).
  \n
- quality_score (number): The quality score of the channel (1 = 🟢 Green, 2 = 🟡 Yellow, 3 = 🔴 Red).
  \n
- quality_reasons (null | array): Reasons for the quality score, if available.
  \n
- has_official_verification (boolean): Whether the channel has official WhatsApp verification.
  \n
- daily_limit (number): The daily messaging limit for the channel.
  \n
- account_type (number): The type of the channel's account (1 = Sandbox, 2 = Standard, 4 = Agency).
  \n
- is_active (boolean): Whether the channel is currently active.
  \n
\n

Example Response

[\n  {\n    \"id\": 2009,\n    \"name\": \"Spoki_tyntec\",\n    \"current_credit\": 100.0,\n    \"status\": \"active\",\n    \"default_language\": \"it\",\n    \"phone\": \"+391234567890\",\n    \"has_official_verification\": true,\n    \"daily_limit\": 1000,\n    \"phone_status\": \"Connected\",\n    \"quality_score\": 1,\n    \"quality_reasons\": null,\n    \"is_active\": true,\n    \"country_code\": \"IT\",\n    \"estimated_available_conversations\": 500,\n    \"account_type\": 2,\n    \"default_pricing_delta\": 0.0,\n    \"low_credit_threshold\": 10.0,\n    \"has_low_credit_alert\": false,\n    \"default_prefix\": \"+39\",\n    \"default_country_code\": \"IT\",\n    \"timezone\": \"Europe/Rome\",\n    \"contacted_in_24h\": 12,\n    \"contacted_in_7d\": 84,\n    \"primary_channel_id\": 17,\n    \"channels\": [\n      {\n        \"id\": 17,\n        \"name\": \"Main Channel\",\n        \"phone\": \"+391234567890\",\n        \"phone_status\": \"Connected\",\n        \"quality_score\": 1,\n        \"quality_reasons\": null,\n        \"has_official_verification\": true,\n        \"daily_limit\": 1000,\n        \"account_type\": 2,\n        \"is_active\": true\n      }\n    ]\n  }\n]\n\n

Rate Limit: 5/min

This endpoint retrieves a single account by its ID.

Path Parameters

id (number): The unique identifier of the account to retrieve.

Response

The response is a single object representing the account with the following properties:

id (number): The unique identifier for the account.
\n
name (string): The name associated with the account.
\n
current_credit (number): The current credit balance for the account.
\n
status (string): The status of the account.
\n
default_language (string): The default language set for the account.
\n
phone (string): The phone number associated with the account.
\n
has_official_verification (boolean): Indicates whether the account has official verification.
\n
daily_limit (number): The daily limit for the account.
\n
phone_status (string): The status for the phone.
\n
- 🟢 Connected
  \n
- 🟡 Flagged
  \n
- 🔴 Restricted
  \n
- 🚫 Banned
  \n
- 📵 Disconnected
  \n
- Ⓜ️ Migrated
  \n
- ⏳ Pending
  \n
- ⛔️ Rate limited
  \n
- ❗️ Unverified
  \n
\n
quality_score (number): The quality score of the account.
\n
- 1 : 🟢 Green
  \n
- 2 : 🟡 Yellow
  \n
- 3 : 🔴 Red
  \n
\n
quality_reasons (null | array): Reasons for the quality score (if available).
\n
is_active (boolean): Indicates whether the account is active.
\n
country_code (string): The country code associated with the account.
\n
estimated_available_conversations (number): The estimated available conversations for the account.
\n
account_type (number): The type of the account.
\n
- 1 : Sandbox
  \n
- 2 : Standard
  \n
- 4 : Agency
  \n
\n
default_pricing_delta (number): The default pricing delta for the account.
\n
low_credit_threshold (number): The low credit threshold for the account.
\n
has_low_credit_alert (boolean): Indicates whether the account has a low credit alert.
\n
default_prefix (string): The default prefix for the account.
\n
default_country_code (string): The default country code for the account.
\n
timezone (string): The timezone set for the account.
\n
contacted_in_24h (number): Number of contacts made in the last 24 hours for the account.
\n
contacted_in_7d (number): Number of contacts made in the last 7 days for the account.
\n
primary_channel_id (number | null): The ID of the primary channel associated with the account. null if no primary channel is set.
\n
channels (array): List of channels associated with the account. Each channel object follows the AccountChannelSerializer shape with the following 10 fields:
\n
- id (number): The unique identifier for the channel.
  \n
- name (string): The display name of the channel.
  \n
- phone (string): The phone number associated with the channel.
  \n
- phone_status (string): The connection status of the channel's phone number (same values as account-level phone_status).
  \n
- quality_score (number): The quality score of the channel (1 = 🟢 Green, 2 = 🟡 Yellow, 3 = 🔴 Red).
  \n
- quality_reasons (null | array): Reasons for the quality score, if available.
  \n
- has_official_verification (boolean): Whether the channel has official WhatsApp verification.
  \n
- daily_limit (number): The daily messaging limit for the channel.
  \n
- account_type (number): The type of the channel's account (1 = Sandbox, 2 = Standard, 4 = Agency).
  \n
- is_active (boolean): Whether the channel is currently active.
  \n
\n

Example Response

{\n  \"id\": 2009,\n  \"name\": \"Spoki_tyntec\",\n  \"current_credit\": 100.0,\n  \"status\": \"active\",\n  \"default_language\": \"it\",\n  \"phone\": \"+391234567890\",\n  \"has_official_verification\": true,\n  \"daily_limit\": 1000,\n  \"phone_status\": \"Connected\",\n  \"quality_score\": 1,\n  \"quality_reasons\": null,\n  \"is_active\": true,\n  \"country_code\": \"IT\",\n  \"estimated_available_conversations\": 500,\n  \"account_type\": 2,\n  \"default_pricing_delta\": 0.0,\n  \"low_credit_threshold\": 10.0,\n  \"has_low_credit_alert\": false,\n  \"default_prefix\": \"+39\",\n  \"default_country_code\": \"IT\",\n  \"timezone\": \"Europe/Rome\",\n  \"contacted_in_24h\": 12,\n  \"contacted_in_7d\": 84,\n  \"primary_channel_id\": 17,\n  \"channels\": [\n    {\n      \"id\": 17,\n      \"name\": \"Main Channel\",\n      \"phone\": \"+391234567890\",\n      \"phone_status\": \"Connected\",\n      \"quality_score\": 1,\n      \"quality_reasons\": null,\n      \"has_official_verification\": true,\n      \"daily_limit\": 1000,\n      \"account_type\": 2,\n      \"is_active\": true\n    }\n  ]\n}\n

Rate Limit: 5/min

Reverse-lookup endpoint: given a phone number, returns the account that owns it along with the matched channel and the full channel list.

Path Parameters

phone (string): The phone number to look up (E.164 format recommended, e.g. +391234567890).

Response

On success the response is a single object with all standard account fields plus the following additional properties:

id (number): The unique identifier for the account.
\n
name (string): The name associated with the account.
\n
current_credit (number): The current credit balance for the account.
\n
status (string): The status of the account.
\n
default_language (string): The default language set for the account.
\n
phone (string): The phone number associated with the account.
\n
has_official_verification (boolean): Indicates whether the account has official verification.
\n
daily_limit (number): The daily limit for the account.
\n
phone_status (string): The status for the phone.
\n
- 🟢 Connected
  \n
- 🟡 Flagged
  \n
- 🔴 Restricted
  \n
- 🚫 Banned
  \n
- 📵 Disconnected
  \n
- Ⓜ️ Migrated
  \n
- ⏳ Pending
  \n
- ⛔️ Rate limited
  \n
- ❗️ Unverified
  \n
\n
quality_score (number): The quality score of the account.
\n
- 1 : 🟢 Green
  \n
- 2 : 🟡 Yellow
  \n
- 3 : 🔴 Red
  \n
\n
quality_reasons (null | array): Reasons for the quality score (if available).
\n
is_active (boolean): Indicates whether the account is active.
\n
country_code (string): The country code associated with the account.
\n
estimated_available_conversations (number): The estimated available conversations for the account.
\n
account_type (number): The type of the account.
\n
- 1 : Sandbox
  \n
- 2 : Standard
  \n
- 4 : Agency
  \n
\n
default_pricing_delta (number): The default pricing delta for the account.
\n
low_credit_threshold (number): The low credit threshold for the account.
\n
has_low_credit_alert (boolean): Indicates whether the account has a low credit alert.
\n
default_prefix (string): The default prefix for the account.
\n
default_country_code (string): The default country code for the account.
\n
timezone (string): The timezone set for the account.
\n
contacted_in_24h (number): Number of contacts made in the last 24 hours for the account.
\n
contacted_in_7d (number): Number of contacts made in the last 7 days for the account.
\n
matched_channel_id (number): The ID of the channel whose phone number matched the lookup.
\n
channel (object): The matched channel object, following the AccountChannelSerializer shape with the following 10 fields:
\n
- id (number): The unique identifier for the channel.
  \n
- name (string): The display name of the channel.
  \n
- phone (string): The phone number associated with the channel.
  \n
- phone_status (string): The connection status of the channel's phone number (same values as account-level phone_status).
  \n
- quality_score (number): The quality score of the channel (1 = 🟢 Green, 2 = 🟡 Yellow, 3 = 🔴 Red).
  \n
- quality_reasons (null | array): Reasons for the quality score, if available.
  \n
- has_official_verification (boolean): Whether the channel has official WhatsApp verification.
  \n
- daily_limit (number): The daily messaging limit for the channel.
  \n
- account_type (number): The type of the channel's account (1 = Sandbox, 2 = Standard, 4 = Agency).
  \n
- is_active (boolean): Whether the channel is currently active.
  \n
\n
primary_channel_id (number | null): The ID of the primary channel associated with the account. null if no primary channel is set.
\n
channels (array): Full list of all channels associated with the account. Each object follows the same 10-field AccountChannelSerializer shape as channel above.
\n

Error Response

If no channel matches the given phone number, the API returns:

Status: 404 Not Found

{\n  \"detail\": \"Channel not found\"\n}\n

Example Response (200 OK)

{\n  \"id\": 2009,\n  \"name\": \"Spoki_tyntec\",\n  \"current_credit\": 100.0,\n  \"status\": \"active\",\n  \"default_language\": \"it\",\n  \"phone\": \"+391234567890\",\n  \"has_official_verification\": true,\n  \"daily_limit\": 1000,\n  \"phone_status\": \"Connected\",\n  \"quality_score\": 1,\n  \"quality_reasons\": null,\n  \"is_active\": true,\n  \"country_code\": \"IT\",\n  \"estimated_available_conversations\": 500,\n  \"account_type\": 2,\n  \"default_pricing_delta\": 0.0,\n  \"low_credit_threshold\": 10.0,\n  \"has_low_credit_alert\": false,\n  \"default_prefix\": \"+39\",\n  \"default_country_code\": \"IT\",\n  \"timezone\": \"Europe/Rome\",\n  \"contacted_in_24h\": 12,\n  \"contacted_in_7d\": 84,\n  \"matched_channel_id\": 15,\n  \"channel\": {\n    \"id\": 15,\n    \"name\": \"Secondary Channel\",\n    \"phone\": \"+391234567890\",\n    \"phone_status\": \"Connected\",\n    \"quality_score\": 1,\n    \"quality_reasons\": null,\n    \"has_official_verification\": true,\n    \"daily_limit\": 1000,\n    \"account_type\": 2,\n    \"is_active\": true\n  },\n  \"primary_channel_id\": 17,\n  \"channels\": [\n    {\n      \"id\": 15,\n      \"name\": \"Secondary Channel\",\n      \"phone\": \"+391234567890\",\n      \"phone_status\": \"Connected\",\n      \"quality_score\": 1,\n      \"quality_reasons\": null,\n      \"has_official_verification\": true,\n      \"daily_limit\": 1000,\n      \"account_type\": 2,\n      \"is_active\": true\n    },\n    {\n      \"id\": 17,\n      \"name\": \"Main Channel\",\n      \"phone\": \"+399876543210\",\n      \"phone_status\": \"Connected\",\n      \"quality_score\": 1,\n      \"quality_reasons\": null,\n      \"has_official_verification\": true,\n      \"daily_limit\": 1000,\n      \"account_type\": 2,\n      \"is_active\": true\n    }\n  ]\n}\n

Rate Limit: 5/min
Caching Policy: The result will be cached for 30 minutes.

This endpoint retrieves the current report for a specific account.

Response

The response for this request is a JSON object with the following schema:

{\n  \"account\": \"number\",\n  \"period_start\": \"string\",\n  \"contacted_contacts\": \"number\",\n  \"template_message_count\": \"number\",\n  \"free_message_count\": \"number\",\n  \"incoming_message_count\": \"number\",\n  \"exchanged_messages\": \"number\",\n  \"sent_message_count\": \"number\",\n  \"delivered_message_count\": \"number\",\n  \"read_message_count\": \"number\",\n  \"conversation_count\": \"number\"\n}\n\n

The response includes various metrics related to the current report for the specified account.

Creates an onboarding link for the specified account.

This endpoint is no longer active. The action body has been deleted server-side. Any call to POST /accounts/{id}/onboarding/ will receive:

{\n  \"detail\": \"Not found.\"\n}\n

Migration

Replace calls to this endpoint with POST /channel/ passing platform=1. The response shape is identical:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Description
`redirect_url`	string	The URL to redirect the user to for onboarding.
`auth_token`	string	The authentication token for the onboarding session.
`lang`	string	The language code for the onboarding flow.

Example Response (from POST /channel/ with platform=1)

{\n  \"redirect_url\": \"https://onboarding.spoki.it/start?token=abc123\",\n  \"auth_token\": \"abc123\",\n  \"lang\": \"it\"\n}\n

Rate Limit: 5/min

This endpoint retrieves a list of agencies.

Response

The response for this request will be a JSON array containing objects with the following properties:

id (number): The ID of the agency.
\n
account (number): The account associated with the agency.
\n

Example response body:

[\n    {\n        \"id\": 0,\n        \"account\": 0\n    }\n]\n\n

Request Body

This request does not require a request body.

\n","urlObject":{"path":["api","1","agencies",""],"host":["{{Base-URL}}"],"query":[],"variable":[]}},"response":[{"id":"dabdda50-2024-4e4d-88e4-036948496c82","name":"200 OK","originalRequest":{"method":"GET","header":[{"key":"X-Spoki-Api-Key","value":"{{Api-Key}}","type":"text"}],"url":"{{Base-URL}}/api/1/agencies/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.14.0 (Ubuntu)"},{"key":"Date","value":"Mon, 19 Sep 2022 07:24:39 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"25"},{"key":"Connection","value":"keep-alive"},{"key":"Allow","value":"GET, HEAD, OPTIONS"},{"key":"Vary","value":"Origin, Cookie"},{"key":"X-Frame-Options","value":"DENY"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Strict-Transport-Security","value":"max-age=31536000"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": 12344,\n \"account\": 987654\n }\n]"}],"_postman_id":"cf1f817b-724c-4f58-828e-041085dbd3bf"},{"name":"Retrieve agency","id":"93c360ca-7f9a-46d8-a517-8d1b551fa9ce","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"X-Spoki-Api-Key","value":"{{Api-Key}}","type":"text"}],"url":"{{Base-URL}}/api/1/agencies/{{id}}/","description":"

Rate Limit: 5/min

Response

The response will include the details of the agency, such as its ID, account information, and a list of clients associated with the agency. Each client object contains details such as ID, name, current credit, status, default language, phone number, verification status, daily limit, and more.

The estimated_available_conversations field is the number of start-up conversations estimated based on the country_code associated with the customer's account.
It estimates the number of conversations that can be initiated to users with the same country_code.
It can change in reality.

\n","urlObject":{"path":["api","1","agencies","{{id}}",""],"host":["{{Base-URL}}"],"query":[],"variable":[]}},"response":[{"id":"23635f8e-c6f2-4471-a2d2-caf8d373140a","name":"200 OK","originalRequest":{"method":"GET","header":[{"key":"X-Spoki-Api-Key","value":"{{Api-Key}}","type":"text"}],"url":"{{Base-URL}}/api/1/agencies/{{id}}/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.14.0 (Ubuntu)"},{"key":"Date","value":"Mon, 19 Sep 2022 07:29:54 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"2812"},{"key":"Connection","value":"keep-alive"},{"key":"Allow","value":"GET, HEAD, OPTIONS"},{"key":"Vary","value":"Origin, Cookie"},{"key":"X-Frame-Options","value":"DENY"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Strict-Transport-Security","value":"max-age=31536000"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 12344,\n \"account\": 987654,\n \"clients\": [\n {\n \"id\": 1273716,\n \"name\": \"MyClient\",\n \"current_credit\": 523640,\n \"status\": \"Active\",\n \"default_language\": null,\n \"phone\": \"+447782358717\",\n \"has_official_verification\": false,\n \"daily_limit\": 1000,\n \"phone_status\": \"🟢 Connected\",\n \"quality_score\": 0,\n \"quality_reasons\": \"\",\n \"is_active\": true,\n \"country_code\": \"IT\",\n \"estimated_available_conversations\": 120,\n \"account_type\": 2,\n \"default_pricing_delta\": 0,\n \"low_credit_threshold\": 15000,\n \"has_low_credit_alert\": true,\n \"default_prefix\": \"+39\",\n \"default_country_code\": \"IT\",\n \"timezone\": \"Europe/Rome\",\n \"contacted_in_24h\": 30,\n \"contacted_in_7d\": 120\n }\n ]\n}"}],"_postman_id":"93c360ca-7f9a-46d8-a517-8d1b551fa9ce"}],"id":"c74314a9-87d3-49e7-838e-be8b6f1101c0","_postman_id":"c74314a9-87d3-49e7-838e-be8b6f1101c0","description":"","auth":{"type":"apikey","apikey":{"value":"{{Api-Key}}","key":""},"isInherited":true,"source":{"_postman_id":"b0f8e61f-7a2d-488c-8c5b-2835b092a3f9","id":"b0f8e61f-7a2d-488c-8c5b-2835b092a3f9","name":"Spoki API","type":"collection"}}},{"name":"Automations","item":[{"name":"Start Automation","id":"083a9c63-d691-4ace-9c65-2cdc2d9a6ce0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"secret\": \"{{secret}}\",\n \"phone\": \"{{phone}}\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"email\": \"john.doe@domain.com\",\n \"language\": \"en\",\n \"custom_fields\": {\n \"ORDER_ID\": \"1234\"\n },\n \"metadata\": {\n \"your_str_meta\": \"lorem ipsum\",\n \"your_int_meta\": 3,\n \"your_float_meta\": 42.5,\n \"your_bool_meta\": true\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{Base-URL}}/wh/ap/{{uuid}}/","description":"

This endpoint allows you to start an automation created on Spoki Platform.

Important: You don’t need the API_KEY to use this API. Just get the WEBHOOK_SECRET from the Automation Detail as shown below.

","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"d4c9e9e1-781d-4cf8-a037-b2f92bd7f2fa","id":"d4c9e9e1-781d-4cf8-a037-b2f92bd7f2fa","name":"Automations","type":"folder"}},"urlObject":{"path":["wh","ap","{{uuid}}",""],"host":["{{Base-URL}}"],"query":[],"variable":[]}},"response":[{"id":"a5b0a585-3de0-460a-a82c-e2a9f6d63856","name":"200 OK","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"secret\": \"{{secret}}\",\n \"phone\": \"{{phone}}\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"email\": \"john.doe@domain.com\",\n \"language\": \"en\",\n \"custom_fields\": {\n \"ORDER_ID\": \"1234\"\n },\n \"metadata\": {\n \"your_str_meta\": \"lorem ipsum\",\n \"your_int_meta\": 3,\n \"your_float_meta\": 42.5,\n \"your_bool_meta\": true\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{Base-URL}}/wh/ap/{{uuid}}/"},"status":"OK","code":200,"_postman_previewlanguage":"html","header":[{"key":"Server","value":"nginx/1.14.0 (Ubuntu)"},{"key":"Date","value":"Thu, 15 Sep 2022 13:11:30 GMT"},{"key":"Content-Type","value":"text/html; charset=utf-8"},{"key":"Content-Length","value":"0"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Origin"},{"key":"X-Frame-Options","value":"DENY"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Strict-Transport-Security","value":"max-age=31536000"}],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"083a9c63-d691-4ace-9c65-2cdc2d9a6ce0"},{"name":"Start Automation for many contacts","id":"b3ad8aa9-dd95-4681-879c-3a4bf3aff158","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"secret\": \"{{secret}}\",\n \"contacts\": [\n {\n \"phone\": \"{{phone}}\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"email\": \"john.doe@domain.com\",\n \"language\": \"en\",\n \"custom_fields\": {\n \"ORDER_ID\": \"1234\"\n }\n },\n {\n \"phone\": \"+39333123461234\",\n \"first_name\": \"Giovanni\",\n \"last_name\": \"Bianchi\",\n \"email\": \"giovanni.bianchi@domain.com\",\n \"custom_fields\": {\n \"ORDER_ID\": \"4222\"\n },\n \"metadata\": {\n \"your_str_meta\": \"lorem ipsum\",\n \"your_int_meta\": 3,\n \"your_float_meta\": 42.5,\n \"your_bool_meta\": true\n }\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{Base-URL}}/wh/ap/{{uuid}}/bulk/","description":"

This endpoint allows you to start an automation created on Spoki Platform.

Important: You don’t need the API_KEY to use this API. Just get the WEBHOOK_SECRET from the Automation Detail as shown below.

Max contacts allowed: 500.

\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"d4c9e9e1-781d-4cf8-a037-b2f92bd7f2fa","id":"d4c9e9e1-781d-4cf8-a037-b2f92bd7f2fa","name":"Automations","type":"folder"}},"urlObject":{"path":["wh","ap","{{uuid}}","bulk",""],"host":["{{Base-URL}}"],"query":[],"variable":[]}},"response":[{"id":"0c0dc71d-faab-402b-8436-3bf8e17b65aa","name":"200 OK","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"secret\": \"{{secret}}\",\n \"contacts\": [\n {\n \"phone\": \"{{phone}}\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"email\": \"john.doe@domain.com\",\n \"language\": \"en\",\n \"custom_fields\": {\n \"ORDER_ID\": \"1234\"\n }\n },\n {\n \"phone\": \"+39333123461234\",\n \"first_name\": \"Giovanni\",\n \"last_name\": \"Bianchi\",\n \"email\": \"giovanni.bianchi@domain.com\",\n \"custom_fields\": {\n \"ORDER_ID\": \"4222\"\n },\n \"metadata\": {\n \"your_str_meta\": \"lorem ipsum\",\n \"your_int_meta\": 3,\n \"your_float_meta\": 42.5,\n \"your_bool_meta\": true\n }\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{Base-URL}}/wh/ap/{{uuid}}/bulk/"},"status":"OK","code":200,"_postman_previewlanguage":"html","header":[{"key":"Server","value":"nginx/1.14.0 (Ubuntu)"},{"key":"Date","value":"Thu, 15 Sep 2022 13:18:19 GMT"},{"key":"Content-Type","value":"text/html; charset=utf-8"},{"key":"Content-Length","value":"0"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Origin"},{"key":"X-Frame-Options","value":"DENY"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Strict-Transport-Security","value":"max-age=31536000"}],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"b3ad8aa9-dd95-4681-879c-3a4bf3aff158"},{"name":"List, search, and filter automations","id":"84e7037e-efee-419f-bc77-7180d397a50f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"X-Spoki-Api-Key","value":"{{Api-Key}}","type":"text"}],"url":"{{Base-URL}}/api/1/automations/","description":"

Rate Limit: 60/min

\n","urlObject":{"path":["api","1","automations",""],"host":["{{Base-URL}}"],"query":[{"disabled":true,"description":{"content":"

You can search by: name, webhook link

\n","type":"text/plain"},"key":"search","value":""},{"disabled":true,"description":{"content":"

Api, Active Campaign, Woocommerce, Magento, Prestashop, Shopify, Zapier, Qapla', BrainLead, HubSpot, Klaviyo, Zoho, Sendinblue, WPNotif, Connectif, IFTTT, Pipedrive, Meta, Zendesk

\n","type":"text/plain"},"key":"webhook_platform","value":""},{"disabled":true,"description":{"content":"

true, false

\n","type":"text/plain"},"key":"is_active","value":""}],"variable":[]}},"response":[{"id":"e3632a47-3921-43f2-ab7b-8c19d1cdf98e","name":"200 OK","originalRequest":{"method":"GET","header":[{"key":"X-Spoki-Api-Key","value":"{{Api-Key}}","type":"text"}],"url":"{{Base-URL}}/api/1/automations/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.14.0 (Ubuntu)"},{"key":"Date","value":"Thu, 22 Dec 2022 13:57:24 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"2720"},{"key":"Connection","value":"keep-alive"},{"key":"Allow","value":"GET, HEAD, OPTIONS"},{"key":"Vary","value":"Origin, Cookie"},{"key":"X-Frame-Options","value":"DENY"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Strict-Transport-Security","value":"max-age=31536000"}],"cookie":[],"responseTime":null,"body":"{\n \"count\": 7,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n {\n \"id\": 345016,\n \"name\": \"test_automation\",\n \"first_message_text\": \"Ciao %%SENTENCE%%\\nA presto\",\n \"webhook_set\": [\n {\n \"uuid\": \"e9ed4c53-2c33-4137-bfdb-e23f9d679c53\",\n \"link\": \"https://app.spoki.it/wh/ap/e9ed4c53-2c33-4137-bfdb-e23f9d679c53/\",\n \"secret\": \"2dced9e911c247dcbeca6bbbaa26e0a4\",\n \"is_active\": true\n }\n ],\n \"created_datetime\": \"2022-09-16T10:21:56.564216+02:00\",\n \"updated_datetime\": \"2022-12-22T14:55:54.431910+01:00\",\n \"is_active\": true\n },\n {\n \"id\": 345015,\n \"name\": \"supporto\",\n \"first_message_text\": \"Ciao, ti do il benvenuto nella nostra area dedicata al supporto! \\r\\n\\r\\nCome posso aiutarti?\",\n \"webhook_set\": [],\n \"created_datetime\": \"2022-09-16T10:21:56.544937+02:00\",\n \"updated_datetime\": \"2022-09-16T10:21:56.563198+02:00\",\n \"is_active\": true\n },\n {\n \"id\": 345014,\n \"name\": \"supporto_3\",\n \"first_message_text\": \"Perfetto! 👍👍👍\\r\\nIn basso il link per prenotare una consulenza con il nostro esperto. Le consulenze hanno una durata di 45' e si terranno su Google Meet. \\r\\nGrazie ai consigli dei nostri esperti potrai rendere più performanti le tue attività!\\r\\nTroverai tutto nel tuo calendario!\",\n \"webhook_set\": [],\n \"created_datetime\": \"2022-09-16T10:21:56.526027+02:00\",\n \"updated_datetime\": \"2022-09-16T10:21:56.544066+02:00\",\n \"is_active\": true\n },\n {\n \"id\": 345013,\n \"name\": \"supporto_2\",\n \"first_message_text\": \"Descrivi brevemente la tua necessità, un nostro operatore sta prendendo in carico la tua richiesta.\\n\\nTi invito nel frattempo a visualizzare la sezione \\\"video tutorial\\\" del nostro sito, troverai tantissimi video su come utilizzare al meglio il prodotto!\",\n \"webhook_set\": [],\n \"created_datetime\": \"2022-09-16T10:21:56.502145+02:00\",\n \"updated_datetime\": \"2022-09-16T10:21:56.525112+02:00\",\n \"is_active\": true\n },\n {\n \"id\": 345012,\n \"name\": \"promo_2\",\n \"first_message_text\": null,\n \"webhook_set\": [],\n \"created_datetime\": \"2022-09-16T10:21:56.484521+02:00\",\n \"updated_datetime\": \"2022-09-16T10:21:56.501283+02:00\",\n \"is_active\": true\n },\n {\n \"id\": 345011,\n \"name\": \"promo\",\n \"first_message_text\": \"Ciao, abbiamo una bellissima notizia per te! 😍\\r\\n\\r\\nDa oggi *fino a fine mese* avrai la possibilità di acquistare *i tuoi costumi preferiti* a *metà prezzo* 🛍!\\r\\n\\r\\nSfoglia il catalogo e scegli il tuo modello preferito 👇\",\n \"webhook_set\": [],\n \"created_datetime\": \"2022-09-16T10:21:56.467132+02:00\",\n \"updated_datetime\": \"2022-09-16T10:21:56.483663+02:00\",\n \"is_active\": true\n },\n {\n \"id\": 345010,\n \"name\": \"carrello_abbandonato\",\n \"first_message_text\": \"Ciao %%FIRST_NAME%%, hai lasciato i tuoi articoli preferiti nel carrello! 🛒\\r\\n\\r\\nCompleta ora il tuo ordine 👉 %%CHECKOUT_LINK%%\\r\\n\\r\\nHai bisogno di supporto? Contattaci 👇\",\n \"webhook_set\": [],\n \"created_datetime\": \"2022-09-16T10:21:56.430977+02:00\",\n \"updated_datetime\": \"2022-09-16T10:21:56.466249+02:00\",\n \"is_active\": true\n }\n ]\n}"}],"_postman_id":"84e7037e-efee-419f-bc77-7180d397a50f"},{"name":"Retrieve automation","id":"9711abeb-0666-494c-a553-611ec8b35dc2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"X-Spoki-Api-Key","value":"{{Api-Key}}","type":"text"}],"url":"{{Base-URL}}/api/1/automations/{{id}}/","description":"

Rate Limit: 60/min

\n","urlObject":{"path":["api","1","automations","{{id}}",""],"host":["{{Base-URL}}"],"query":[],"variable":[]}},"response":[{"id":"b9e5104e-88c6-4603-90db-21b4217e6500","name":"200 OK","originalRequest":{"method":"GET","header":[{"key":"X-Spoki-Api-Key","value":"{{Api-Key}}","type":"text"}],"url":"{{Base-URL}}/api/1/automations/{{id}}/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.14.0 (Ubuntu)"},{"key":"Date","value":"Thu, 22 Dec 2022 13:59:22 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"412"},{"key":"Connection","value":"keep-alive"},{"key":"Allow","value":"GET, HEAD, OPTIONS"},{"key":"Vary","value":"Origin, Cookie"},{"key":"X-Frame-Options","value":"DENY"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Strict-Transport-Security","value":"max-age=31536000"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 345016,\n \"name\": \"test_automation\",\n \"first_message_text\": \"Ciao %%SENTENCE%%\\nA presto\",\n \"webhook_set\": [\n {\n \"uuid\": \"e9ed4c53-2c33-4137-bfdb-e23f9d679c53\",\n \"link\": \"https://app.spoki.it/wh/ap/e9ed4c53-2c33-4137-bfdb-e23f9d679c53/\",\n \"secret\": \"2dced9e911c247dcbeca6bbbaa26e0a4\",\n \"is_active\": true\n }\n ],\n \"created_datetime\": \"2022-09-16T10:21:56.564216+02:00\",\n \"updated_datetime\": \"2022-12-22T14:55:54.431910+01:00\",\n \"is_active\": true\n}"}],"_postman_id":"9711abeb-0666-494c-a553-611ec8b35dc2"},{"name":"Create Automation","id":"e3731a3d-af6d-457b-a498-dfa27c293787","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"{{Base-URL}}/api/1/automations/","description":"

Create Automation

POST Create automation

https://api.spoki.com/api/1/automations/\n\n

Rate Limit: 60/min

Overview

Create a new automation with support for steps, triggers, and automation groups in a single request. Steps are created in the order provided and can include delays, messages, webhooks, tags, operators, and more. Triggers define when the automation starts (e.g., on first message, on webhook, on field condition).

HEADERS

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Header	Value
X-Spoki-Api-Key	{{Api-Key}}
Content-Type	application/json

Request Body Structure

Root Level Fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
name	string	Yes	Name of the automation
description	string	No	Description of the automation
category	string	No	Category of the automation
is_active	boolean	No	Whether the automation is active. Default: `true`
is_favorite	boolean	No	Whether the automation is marked as favorite. Default: `false`
automation_groups	array[integer]	No	List of automation group IDs to assign
steps	array[object]	No	List of step objects to create (see Step Types below)

Trigger Fields (all optional)

Field	Type	Description
webhook_set	array[object]	Webhook triggers
onfirstmessagestarter_set	array[object]	First message triggers
fieldconditionstarter_set	array[object]	Field condition triggers
onopeninghoursstarter_set	array[object]	Opening hours triggers
onclosinghoursstarter_set	array[object]	Closing hours triggers
onholidayhoursstarter_set	array[object]	Holiday hours triggers
metaadsconditionstarter_set	array[object]	Meta Ads condition triggers
onticketcreatestarter_set	array[object]	Ticket creation triggers
onticketstatuschangestarter_set	array[object]	Ticket status change triggers
accountpaymentrequeststarter_set	array[object]	Payment request triggers
oninboundmessageorderstarter_set	array[object]	Inbound message order triggers
oninboundmessageproductstarter_set	array[object]	Inbound message product triggers
onmarketingacceptancestatuschangestarter_set	array[object]	Marketing acceptance status triggers
googlesheetstrigger_set	array[object]	Google Sheets triggers
ondealcreatestarter_set	array[object]	Deal creation triggers
ondealupdatestarter_set	array[object]	Deal update triggers
ondealcontactupdatedstarter_set	array[object]	Deal contact updated triggers
ondealstagechangestarter_set	array[object]	Deal stage change triggers

Trigger Details

Each trigger type has its own required and optional fields. See the Trigger Types Reference section for full field definitions and examples for each trigger.

Step Types Reference

Each step object in the steps array must include a step_type field as a string label (case-insensitive).

Common Fields (all steps)

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
step_type	string	Yes	Step type label (see table below)
position	integer	No	Step position in the automation. Automatically assigned based on array index (0, 1, 2, ...) unless explicitly provided
note	string	No	Internal note for this step (not visible to contacts)
reference	string	No	Reference identifier. Used to link child steps to button flows in InteractiveMessage/ListMessage
key	string	No	Step key identifier. Used by GoToStep to reference this step as a jump target
step_set	array[object]	No	Array of child step objects. Used for: button sub-flows in InteractiveMessage/ListMessage (requires `reference`), and the false branch in IfElse (no `reference` needed)

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Label	Description
`Delay`	Pause automation
`TemplateMessage`	Send WhatsApp template
`FreeMessage`	Send free-form text
`ReadMessage`	Wait for reply
`Webhook`	Send HTTP request
`AddTag`	Add tag to contact
`RemoveTag`	Remove tag
`AddToList`	Add to list
`RemoveFromList`	Remove from list
`CustomField`	Set custom field
`BlockContact`	Block contact
`InteractiveMessage`	Message with buttons
`AddOperator`	Assign operator
`RemoveOperator`	Remove operator
`ListMessage`	Message with menu list
`OpenTicket`	Open ticket
`UpdateTicket`	Update ticket
`TerminateAutomations`	Stop all automations
`RestoreContact`	Unblock contact
`IfElse`	Conditional branching
`ZapierWebhook`	Zapier webhook
`ActiveCampaign`	Active Campaign
`PayPal`	PayPal payment
`SubAutomation`	Trigger sub-automation
`GoToStep`	Jump to step
`SwitchCase`	Multi-branch routing
`AddNote`	Add chat note
`SetChatUnread`	Mark chat unread
`MarketingAcceptanceStatus`	Set marketing status
`MakeWebhook`	Make (Integromat) webhook
`SMS`	Send SMS
`AIOperator`	AI operator
`Emailchef`	Emailchef integration
`GoogleSheets`	Google Sheets
`SetChatRead`	Mark chat read
`GoogleCalendar`	Google Calendar
`N8nWebhook`	n8n webhook
`TransformContactField`	Transform field value
`HubSpotWebhook`	HubSpot webhook
`GoHighLevelWebhook`	GoHighLevel webhook
`GoogleGmail`	Google Gmail
`UpdateDeal`	Update deal
`CreateDeal`	Create deal
`Voice`	Spoki Voice call

Delay

Pauses the automation for a given number of seconds.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
delay_seconds	integer	No	Delay in seconds. Default: `1000`
conditions	object	No	Optional conditions for conditional delay

{\n    \"step_type\": \"Delay\",\n    \"delay_seconds\": 3600\n}\n\n

Delay with condition (e.g., wait until specific day):

{\n    \"step_type\": \"Delay\",\n    \"delay_seconds\": 3600,\n    \"conditions\": {\n        \"and_conditions\": [\n            {\n                \"condition\": \"equal_to\",\n                \"key\": \"day_of_week\",\n                \"metadata\": \"day_of_week\",\n                \"value\": \"1\"\n            }\n        ]\n    }\n}\n\n

TemplateMessage

Sends a WhatsApp template message.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
template	integer	Yes	Template ID (must belong to your account)
header_media	object	No	Media header configuration. Use when the template has a media header (image, video, document)
custom_field_values	object	No	Dynamic field values for template variables. Keys are the variable position numbers (as strings), values are the dynamic field codes (e.g., `\"dynamic_field_first_name\"`, `\"dynamic_field_\"`)
carousel_headers_media	array	No	Carousel header media items. Used only for carousel-type templates — one media object per carousel card

Simple example — send a template with no variables:

{\n    \"step_type\": \"TemplateMessage\",\n    \"template\": 456\n}\n\n

With custom field values — map template variable positions to contact dynamic fields:

{\n    \"step_type\": \"TemplateMessage\",\n    \"template\": 456,\n    \"custom_field_values\": {\n        \"1\": \"dynamic_field_first_name\",\n        \"2\": \"dynamic_field_55\"\n    }\n}\n\n

FreeMessage

Sends a free-form text message.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
text	string	No	Message text (can be blank)
header_media	object	No	Media attachment

{\n    \"step_type\": \"FreeMessage\",\n    \"text\": \"Hello! Welcome to our service.\"\n}\n\n

ReadMessage

Waits for an inbound message from the contact.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
delay_seconds	integer	No	Timeout in seconds. If set, the automation will continue after this timeout even if no reply is received

{\n    \"step_type\": \"ReadMessage\"\n}\n\n

With timeout:

{\n    \"step_type\": \"ReadMessage\",\n    \"delay_seconds\": 86400\n}\n\n

Webhook

Sends an HTTP request to an external URL.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
url	string (URL)	Yes	Webhook URL
method	string	No	HTTP method: `GET`, `POST`, `PUT`, `PATCH`, `DELETE`. Default: `POST`
headers	object	No	Custom headers
payload	string	No	Request body (max 4096 chars). Must be valid JSON. Max 5 nested objects.
response_data	object	No	Response mapping configuration

{\n    \"step_type\": \"Webhook\",\n    \"url\": \"https://example.com/webhook\",\n    \"method\": \"POST\",\n    \"headers\": {\"Authorization\": \"Bearer token123\"},\n    \"payload\": \"{\\\"contact\\\": \\\"{{phone}}\\\"}\"\n}\n\n

AddTag

Adds one or more tags to the contact.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
tags	array[integer]	No	Tag IDs to add (must belong to your account)
is_all	boolean	No	Apply all tags. Default: `false`

{\n    \"step_type\": \"AddTag\",\n    \"tags\": [123, 456, 789]\n}\n\n

RemoveTag

Removes one or more tags from the contact.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
tags	array[integer]	No	Tag IDs to remove (must belong to your account)
is_all	boolean	No	Remove all tags. Default: `false`

{\n    \"step_type\": \"RemoveTag\",\n    \"tags\": [123, 456]\n}\n\n

Remove all tags:

{\n    \"step_type\": \"RemoveTag\",\n    \"is_all\": true\n}\n\n

AddToList

Adds the contact to one or more lists.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
lists	array[integer]	No	List IDs to add the contact to (must belong to your account)
is_all	boolean	No	Add to all lists. Default: `false`

{\n    \"step_type\": \"AddToList\",\n    \"lists\": [42, 43]\n}\n\n

RemoveFromList

Removes the contact from one or more lists.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
lists	array[integer]	No	List IDs to remove the contact from (must belong to your account)
is_all	boolean	No	Remove from all lists. Default: `false`

{\n    \"step_type\": \"RemoveFromList\",\n    \"lists\": [42]\n}\n\n

CustomField

Sets a custom field value on the contact.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
custom_field	integer	Yes	Custom field ID (must belong to your account)
value	string	No	Value to set on the contact's custom field

{\n    \"step_type\": \"CustomField\",\n    \"custom_field\": 99,\n    \"value\": \"VIP\"\n}\n\n

BlockContact

Blocks the contact (sets is_blocked = true). No additional fields required.

{\n    \"step_type\": \"BlockContact\"\n}\n\n

InteractiveMessage

Sends an interactive message with buttons.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
interactive_message	object	Yes	Nested interactive message object (see structure below)
header_media	object	No	Header media configuration
step_set	array[object]	No	Child steps (button flows). Each child must have a `reference` matching a button's `text`

interactive_message object

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
language	string	No	Language code (e.g., `\"en\"`, `\"it\"`)
header_component	object or null	No	Header component. Pass `null` to omit
body_component	object	Yes	Body component with the message text
footer_component	object or null	No	Footer component. Pass `null` to omit
interactivemessagebuttoncomponent_set	array[object]	Yes	Array of button objects

Component object (header_component, body_component, footer_component)

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
component_type	string	Yes	One of: `\"header\"`, `\"body\"`, `\"footer\"`
format	string	No	For header: `\"text\"`, `\"image\"`, `\"video\"`, `\"document\"`
text	string	Yes	Component text content

Button object (interactivemessagebuttoncomponent_set)

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
text	string	Yes	Button label text (max 20 chars)
button_type	string	Yes	One of: `\"quick_reply\"`, `\"url\"`, `\"phone_number\"`
order	integer	Yes	Button display order (0, 1, 2)
url	string	No	Required for `url` button type
phone_number	string	No	Required for `phone_number` button type

Button types:

quick_reply — Quick reply button (default). Can have child flow steps via step_set
\n
url — URL link button (requires url field)
\n
phone_number — Phone number button (requires phone_number field)
\n

Child steps (step_set): To attach a flow to a button, add a step_set array. Each child step must include reference matching the button's exact text value. Multiple steps with the same reference are chained in the same button flow.

Simple example — one step per button:

{\n    \"step_type\": \"InteractiveMessage\",\n    \"interactive_message\": {\n        \"language\": \"en\",\n        \"header_component\": null,\n        \"body_component\": {\n            \"component_type\": \"body\",\n            \"text\": \"How can we help you?\"\n        },\n        \"footer_component\": null,\n        \"interactivemessagebuttoncomponent_set\": [\n            {\"text\": \"Sales\", \"button_type\": \"quick_reply\", \"order\": 0},\n            {\"text\": \"Support\", \"button_type\": \"quick_reply\", \"order\": 1}\n        ]\n    },\n    \"step_set\": [\n        {\"step_type\": \"Delay\", \"delay_seconds\": 5, \"reference\": \"Sales\"},\n        {\"step_type\": \"Delay\", \"delay_seconds\": 10, \"reference\": \"Support\"}\n    ]\n}\n\n

Multi-step subflow — multiple steps per button:

Use the same reference for all steps in the same button flow. The order within each flow follows the array order.

{\n    \"step_type\": \"InteractiveMessage\",\n    \"interactive_message\": {\n        \"language\": \"en\",\n        \"header_component\": null,\n        \"body_component\": {\n            \"component_type\": \"body\",\n            \"text\": \"Choose a department:\"\n        },\n        \"footer_component\": null,\n        \"interactivemessagebuttoncomponent_set\": [\n            {\"text\": \"Sales\", \"button_type\": \"quick_reply\", \"order\": 0},\n            {\"text\": \"Support\", \"button_type\": \"quick_reply\", \"order\": 1}\n        ]\n    },\n    \"step_set\": [\n        {\"step_type\": \"Delay\", \"delay_seconds\": 5, \"reference\": \"Sales\"},\n        {\"step_type\": \"FreeMessage\", \"text\": \"A sales agent will contact you shortly!\", \"reference\": \"Sales\"},\n        {\"step_type\": \"AddTag\", \"tag\": 100, \"reference\": \"Sales\"},\n        {\"step_type\": \"Delay\", \"delay_seconds\": 10, \"reference\": \"Support\"},\n        {\"step_type\": \"FreeMessage\", \"text\": \"Opening a support ticket...\", \"reference\": \"Support\"}\n    ]\n}\n\n

In this example, the Sales button flow has 3 steps (Delay → FreeMessage → AddTag) and the Support button flow has 2 steps (Delay → FreeMessage).

AddOperator

Assigns one or more operators to the contact's chat.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
roles	array[integer]	No	Role IDs to assign (must belong to your account)
is_all	boolean	No	Assign all operators. Default: `false`

{\n    \"step_type\": \"AddOperator\",\n    \"roles\": [5, 10]\n}\n\n

RemoveOperator

Removes one or more operators from the contact's chat.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
roles	array[integer]	No	Role IDs to remove (must belong to your account)
is_all	boolean	No	Remove all operators. Default: `false`

{\n    \"step_type\": \"RemoveOperator\",\n    \"roles\": [5]\n}\n\n

ListMessage

Sends a list message (menu with selectable items).

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
list_message	object	Yes	Nested list message object (see structure below)
step_set	array[object]	No	Child steps (row flows). Each child must have a `reference` matching a row's `title`

list_message object

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
header_component	object or null	No	Header component (see Component object)
body_component	object	Yes	Body component with the message text
footer_component	object or null	No	Footer component
button_text	string	Yes	Text displayed on the list open button (max 20 chars)
listmessagesection_set	array[object]	Yes	Array of section objects

Section object (listmessagesection_set)

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
title	string	Yes	Section title
listmessagesectionrow_set	array[object]	Yes	Array of row items

Row object (listmessagesectionrow_set)

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
title	string	Yes	Row title (max 24 chars)
description	string	No	Row description (max 72 chars)

{\n    \"step_type\": \"ListMessage\",\n    \"list_message\": {\n        \"header_component\": {\n            \"component_type\": \"header\",\n            \"format\": \"text\",\n            \"text\": \"Our Menu\"\n        },\n        \"body_component\": {\n            \"component_type\": \"body\",\n            \"text\": \"Choose from the list below\"\n        },\n        \"footer_component\": {\n            \"component_type\": \"footer\",\n            \"text\": \"Select an option\"\n        },\n        \"button_text\": \"View Options\",\n        \"listmessagesection_set\": [\n            {\n                \"title\": \"Products\",\n                \"listmessagesectionrow_set\": [\n                    {\n                        \"title\": \"Product A\",\n                        \"description\": \"Description of product A\"\n                    },\n                    {\n                        \"title\": \"Product B\",\n                        \"description\": \"Description of product B\"\n                    }\n                ]\n            }\n        ]\n    }\n}\n\n

OpenTicket

Opens a support ticket for the contact.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
ticket	object	No	Ticket configuration

ticket object

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
ticket_category	integer	No	Ticket category ID

{\n    \"step_type\": \"OpenTicket\",\n    \"ticket\": {\n        \"ticket_category\": 1\n    }\n}\n\n

UpdateTicket

Updates an existing ticket. Same fields as OpenTicket.

{\n    \"step_type\": \"UpdateTicket\",\n    \"ticket\": {\n        \"ticket_category\": 2\n    }\n}\n\n

TerminateAutomations

Terminates all running automations for the contact. No additional type-specific fields required.

{\n    \"step_type\": \"TerminateAutomations\"\n}\n\n

RestoreContact

Unblocks a previously blocked contact (sets is_blocked = false). This is the reverse operation of BlockContact. No additional type-specific fields required.

{\n    \"step_type\": \"RestoreContact\"\n}\n\n

IfElse

Conditional branching based on contact fields or conditions.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
conditions	object	No	Conditions object (see structure below)
step_set	array[object]	No	Child steps for the Else (false) branch — executed when the condition is NOT met. Do not include `reference` on these child steps

Branching behavior

The IfElse step splits the flow into two branches:

True branch (condition met): The automation continues with the next step in the main steps array (the step immediately after the IfElse).
\n
False branch (condition NOT met): The automation executes the child steps defined in step_set.
\n

steps: [\n    { \"step_type\": \"IfElse\", \"conditions\": {...}, \"step_set\": [\n        ← These run when condition is FALSE\n    ]},\n    { \"step_type\": \"AddTag\", ... }     ← This runs when condition is TRUE\n]\n\n

IMPORTANT: The conditions must use a nested structure with two levels:

Outer level: An object with and_conditions or or_conditions — this is an array of groups
\n
Inner level: Each group is an object with and_conditions or or_conditions — this is an array of condition items
\n

conditions: {\n    and_conditions: [          ← Groups joined by AND\n        {\n            and_conditions: [  ← Items within group joined by AND\n                { key, condition, value, metadata }\n            ]\n        }\n    ]\n}\n\n

Use or_conditions at the outer level to join groups with OR logic. Use and_conditions at the inner level to join items within a group with AND logic.

Condition item fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Description
key	string	Field to evaluate (see keys below)
condition	string	Comparison operator (see operators below)
value	string	Value to compare against
metadata	string	Must match the `key` value (e.g., `\"first_name\"`, `\"email\"`). For custom fields use the field name (e.g., `\"Order Total\"`)
date_component	string	For date conditions: `year`, `month`, `day_of_month`, `day_of_week`, `hour`, `minute`, `time`

Available keys

Key	Description	Supported Conditions
`first_name`	Contact first name	equal_to, not_equal_to, contains, not_contains, starts_with, not_starts_with, ends_with, not_ends_with, empty, not_empty
`last_name`	Contact last name	(same as first_name)
`phone`	Contact phone	(same as first_name)
`email`	Contact email	(same as first_name)
`tag`	Has tag	exists, not_exists
`tagcat`	Has tag category	exists, not_exists
`list`	In list	exists, not_exists
`operator`	Has operator	exists, not_exists
`dynamic_field_`	Custom field by ID	equal_to, not_equal_to, contains, not_contains, starts_with, not_starts_with, ends_with, not_ends_with, less_than, less_than_or_equal, greater_than, greater_than_or_equal, empty, not_empty
`ticket_status`	Ticket status	equal_to, not_equal_to
`ticket_priority`	Ticket priority	equal_to, not_equal_to
`conversation_any`	Any active conversation	active, not_active
`whatsapp_sent_message_24h`	WhatsApp message sent in last 24h	is_true, is_false
`whatsapp_received_message_24h`	WhatsApp message received in last 24h	is_true, is_false
`sms_sent_message_24h`	SMS sent in last 24h	is_true, is_false
`sms_received_message_24h`	SMS received in last 24h	is_true, is_false
`current_date`	Current date	day_of_week, day_of_month, year, month, equal_to, not_equal_to, less_than, less_than_or_equal, greater_than, greater_than_or_equal
`current_datetime`	Current datetime	day_of_week, day_of_month, year, month, hour, minute, greater_than, less_than
`current_time`	Current time	greater_than, less_than
`has_invalid_phone`	Invalid phone	is_true, is_false
`is_blocked`	Contact blocked	is_true, is_false
`language`	Contact language	equal_to, not_equal_to
`marketing_acceptance`	Marketing acceptance status. Values: `\"0\"` (not declared), `\"1\"` (subscribed), `\"2\"` (unsubscribed)	equal_to, not_equal_to

Available conditions (operators)

equal_to, not_equal_to, contains, not_contains, greater_than, greater_than_or_equal, less_than, less_than_or_equal, empty, not_empty, starts_with, not_starts_with, ends_with, not_ends_with, is_true, is_false, exists, not_exists, one_of, not_one_of, active, not_active

Example — Single AND condition

{\n    \"step_type\": \"IfElse\",\n    \"conditions\": {\n        \"and_conditions\": [\n            {\n                \"and_conditions\": [\n                    {\n                        \"key\": \"first_name\",\n                        \"condition\": \"contains\",\n                        \"value\": \"Alessandro\",\n                        \"metadata\": \"first_name\"\n                    }\n                ]\n            }\n        ]\n    }\n}\n\n

Example — Multiple AND conditions

{\n    \"step_type\": \"IfElse\",\n    \"conditions\": {\n        \"and_conditions\": [\n            {\n                \"and_conditions\": [\n                    {\n                        \"key\": \"first_name\",\n                        \"condition\": \"not_empty\",\n                        \"value\": \"\",\n                        \"metadata\": \"first_name\"\n                    },\n                    {\n                        \"key\": \"email\",\n                        \"condition\": \"contains\",\n                        \"value\": \"@gmail.com\",\n                        \"metadata\": \"email\"\n                    }\n                ]\n            }\n        ]\n    }\n}\n\n

Example — OR between groups

{\n    \"step_type\": \"IfElse\",\n    \"conditions\": {\n        \"or_conditions\": [\n            {\n                \"and_conditions\": [\n                    {\n                        \"key\": \"tag\",\n                        \"condition\": \"exists\",\n                        \"value\": \"123\",\n                        \"metadata\": \"tag\"\n                    }\n                ]\n            },\n            {\n                \"and_conditions\": [\n                    {\n                        \"key\": \"list\",\n                        \"condition\": \"exists\",\n                        \"value\": \"42\",\n                        \"metadata\": \"list\"\n                    }\n                ]\n            }\n        ]\n    }\n}\n\n

Example — Custom field condition

{\n    \"step_type\": \"IfElse\",\n    \"conditions\": {\n        \"and_conditions\": [\n            {\n                \"and_conditions\": [\n                    {\n                        \"key\": \"dynamic_field_55\",\n                        \"condition\": \"greater_than\",\n                        \"value\": \"100\",\n                        \"metadata\": \"dynamic_field_55\"\n                    }\n                ]\n            }\n        ]\n    }\n}\n\n

Example — No reply condition

{\n    \"step_type\": \"IfElse\",\n    \"conditions\": {\n        \"and_conditions\": [\n            {\n                \"and_conditions\": [\n                    {\n                        \"key\": \"no_reply\",\n                        \"condition\": \"equal_to\",\n                        \"value\": \"3600\",\n                        \"metadata\": \"no_reply\"\n                    }\n                ]\n            }\n        ]\n    }\n}\n\n

Example — IfElse with true/false branch steps

In this example, if the contact has a first name → tag them as \"Known\" (true branch, main flow). If not → tag them as \"Anonymous\" (false branch, step_set).

{\n    \"steps\": [\n        {\n            \"step_type\": \"IfElse\",\n            \"position\": 0,\n            \"conditions\": {\n                \"and_conditions\": [\n                    {\n                        \"and_conditions\": [\n                            {\n                                \"key\": \"first_name\",\n                                \"condition\": \"not_empty\",\n                                \"value\": \"\",\n                                \"metadata\": \"first_name\"\n                            }\n                        ]\n                    }\n                ]\n            },\n            \"step_set\": [\n                {\"step_type\": \"AddTag\", \"position\": 0, \"tag\": 200}\n            ]\n        },\n        {\n            \"step_type\": \"AddTag\",\n            \"position\": 1,\n            \"tag\": 100\n        }\n    ]\n}\n\n

In the flow above:

Condition TRUE (first_name is not empty) → executes AddTag with tag 100 (position 1, main flow)
\n
Condition FALSE (first_name is empty) → executes AddTag with tag 200 (step_set, false branch)
\n

ZapierWebhook

Sends a webhook to Zapier.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
url	string (URL)	Yes	Zapier webhook URL

{\n    \"step_type\": \"ZapierWebhook\",\n    \"url\": \"https://hooks.zapier.com/hooks/catch/123456/abcdef/\"\n}\n\n

ActiveCampaign

Triggers an Active Campaign integration. No specific additional fields.

{\n    \"step_type\": \"ActiveCampaign\"\n}\n\n

PayPal

Sends a PayPal payment request using a template.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
template	integer	Yes	Template ID for PayPal message
custom_field_values	object	No	Dynamic field values

{\n    \"step_type\": \"PayPal\",\n    \"template\": 789\n}\n\n

SubAutomation

Triggers another automation.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
automation_to_start	integer	Yes	Automation ID to trigger

{\n    \"step_type\": \"SubAutomation\",\n    \"automation_to_start\": 5678\n}\n\n

GoToStep

Jumps to another step within the same automation.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
step_key	string	No	Target step key identifier

{\n    \"step_type\": \"GoToStep\",\n    \"step_key\": \"step_abc_123\"\n}\n\n

SwitchCase

Routes the automation into multiple branches based on a contact field value (like a multi-branch If/Else).

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
handled_conditions	array	Yes	List of condition values for routing. Must include `\"DEFAULT_CASE_KEY\"` as the last item for the default/fallback branch
step_key	string	No	Step key identifier
key_metadata	string	Yes	JSON-stringified object (see structure below)

key_metadata structure

The key_metadata field must be a JSON string containing:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Required	Description
casesName	array[string]	Yes	Display labels for each case, in the same order as `handled_conditions`. Must include `\"DEFAULT_CASE_KEY\"` as the last item
key	string	Yes	The contact field to evaluate (e.g., `\"language\"`, `\"priority_level\"`, or a custom field name)
customField	object	No	Custom field reference (when routing by custom field)

IMPORTANT:

handled_conditions contains the values to match against (e.g., \"IT\", \"EN\")
\n
casesName contains the display labels shown in the UI for each case (e.g., \"Italiano\", \"English\")
\n
Both arrays must have the same length and order
\n
Always include \"DEFAULT_CASE_KEY\" as the last element in both handled_conditions and casesName — this is the fallback branch for unmatched values
\n

Example — Route by language

{\n    \"step_type\": \"SwitchCase\",\n    \"handled_conditions\": [\"IT\", \"EN\", \"ES\", \"DEFAULT_CASE_KEY\"],\n    \"key_metadata\": \"{\\\"casesName\\\":[\\\"Italiano\\\",\\\"English\\\",\\\"Español\\\",\\\"DEFAULT_CASE_KEY\\\"],\\\"key\\\":\\\"language\\\"}\"\n}\n\n

Example — Route by custom field

{\n    \"step_type\": \"SwitchCase\",\n    \"step_key\": \"dynamic_field_55\",\n    \"handled_conditions\": [\"HIGH\", \"MEDIUM\", \"LOW\", \"DEFAULT_CASE_KEY\"],\n    \"key_metadata\": \"{\\\"casesName\\\":[\\\"High Priority\\\",\\\"Medium Priority\\\",\\\"Low Priority\\\",\\\"DEFAULT_CASE_KEY\\\"],\\\"key\\\":\\\"priority_level\\\"}\"\n}\n\n

AddNote

Adds a note to the contact's chat.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
text	string	No	Note text
header_media	object	No	Media attachment
ticket_reference	string	No	Reference to ticket

{\n    \"step_type\": \"AddNote\",\n    \"text\": \"Contact requested a callback.\"\n}\n\n

SetChatUnread

Marks the chat as unread. No additional fields required.

{\n    \"step_type\": \"SetChatUnread\"\n}\n\n

MarketingAcceptanceStatus

Changes the marketing acceptance status of the contact.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
status	integer	No	Marketing acceptance status value

{\n    \"step_type\": \"MarketingAcceptanceStatus\",\n    \"status\": 1\n}\n\n

MakeWebhook

Sends a webhook to Make (Integromat).

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
url	string (URL)	Yes	Make webhook URL

{\n    \"step_type\": \"MakeWebhook\",\n    \"url\": \"https://hook.eu1.make.com/abcdef123456\"\n}\n\n

SMS

Sends an SMS message.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
text	string	No	SMS text
is_oneway	boolean	No	One-way SMS. Default: `false`

{\n    \"step_type\": \"SMS\",\n    \"text\": \"Your order has been shipped!\"\n}\n\n

AIOperator

Enables or disables the AI operator for the chat.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
enable	boolean	No	Enable AI operator. Default: `false`

{\n    \"step_type\": \"AIOperator\",\n    \"enable\": true\n}\n\n

Emailchef

Triggers an Emailchef integration.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
url	string	No	Emailchef endpoint URL
custom_fields	object	No	Custom field mapping

{\n    \"step_type\": \"Emailchef\",\n    \"url\": \"https://app.emailchef.com/api/...\",\n    \"custom_fields\": {\n        \"email\": \"dynamic_field_email\",\n        \"name\": \"dynamic_field_first_name\"\n    }\n}\n\n

GoogleSheets

Performs operations on Google Sheets.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
sheet_id	string	Depends	Google Sheet ID (required for `append`, `update`, `create_tab`; optional for `create_sheet`)
sheet_name	string	No	Display name of the sheet
configuration	object	No	Operation configuration (see below)

`configuration` object

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
operation	string	No	`\"append\"` (default), `\"update\"`, `\"create_sheet\"`, or `\"create_tab\"`
sheet_tab	string	No	Tab name within the sheet (for `append`/`update`, e.g. `\"Sheet1\"`, `\"Leads\"`)
columns	object	Yes (append/update)	Column-to-field mapping. Keys are column letters, values are contact field codes or `{{placeholder}}` templates
row_number	integer	Yes (update)	Row number to update
sheet_name	string	No (create_sheet)	Name for the new sheet (defaults to the step's `sheet_name` field or `\"Spoki Data\"`)
tab_name	string	No (create_tab)	Name for the new tab (defaults to `\"New Sheet\"`)

Append row — adds a new row to an existing sheet tab:

{\n    \"step_type\": \"GoogleSheets\",\n    \"sheet_id\": \"1BxiMVs0XRA5nFMdKvBdBZjgmUUqptlbs74OgVE2upms\",\n    \"sheet_name\": \"Customer Data\",\n    \"configuration\": {\n        \"operation\": \"append\",\n        \"sheet_tab\": \"Leads\",\n        \"columns\": {\n            \"A\": \"phone\",\n            \"B\": \"first_name\",\n            \"C\": \"last_name\",\n            \"D\": \"email\"\n        }\n    }\n}\n\n

Update row — updates a specific row:

{\n    \"step_type\": \"GoogleSheets\",\n    \"sheet_id\": \"1BxiMVs0XRA5nFMdKvBdBZjgmUUqptlbs74OgVE2upms\",\n    \"configuration\": {\n        \"operation\": \"update\",\n        \"sheet_tab\": \"Leads\",\n        \"row_number\": 2,\n        \"columns\": {\n            \"A\": \"phone\",\n            \"B\": \"first_name\"\n        }\n    }\n}\n\n

Create new sheet:

{\n    \"step_type\": \"GoogleSheets\",\n    \"configuration\": {\n        \"operation\": \"create_sheet\",\n        \"sheet_name\": \"My New Sheet\"\n    }\n}\n\n

Create new tab — adds a tab to an existing sheet:

{\n    \"step_type\": \"GoogleSheets\",\n    \"sheet_id\": \"1BxiMVs0XRA5nFMdKvBdBZjgmUUqptlbs74OgVE2upms\",\n    \"configuration\": {\n        \"operation\": \"create_tab\",\n        \"tab_name\": \"New Tab\"\n    }\n}\n\n

SetChatRead

Marks chat messages as read, optionally up to a certain date.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
fixed_date_value	string (datetime)	No	Read messages up to this date
fixed_date_custom_field	integer	No	Custom field ID containing the date
period_ago_amount	integer	No	Read messages older than this amount
period_ago_unit	string	No	Time unit for period_ago_amount

{\n    \"step_type\": \"SetChatRead\"\n}\n\n

With date filter:

{\n    \"step_type\": \"SetChatRead\",\n    \"period_ago_amount\": 7,\n    \"period_ago_unit\": \"days\"\n}\n\n

GoogleCalendar

Performs operations on Google Calendar.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
calendar_id	string	Yes	Google Calendar ID (e.g. `\"primary\"`)
calendar_name	string	No	Display name of the calendar
configuration	object	Yes	Event configuration (see below)

`configuration` object

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
operation	string	No	`\"create\"` (default), `\"update\"`, or `\"delete\"`
event_id	string	Yes (update/delete)	Calendar event ID. Supports `%%VARIABLE%%` placeholders
event_title	string	No	Event title. Supports `%%first_name%%` etc.
event_description	string	No	Event description
event_location	string	No	Event location
start_datetime	string	No	ISO datetime or `%%VARIABLE%%`. Used for create/update
end_datetime	string	No	ISO datetime or `%%VARIABLE%%`
duration_minutes	integer	No	Duration in minutes (if `end_datetime` not provided, create only)
time_zone	string	No	IANA timezone (e.g. `\"Europe/Rome\"`). Use `\"accountTimezone\"` for the account's configured timezone
attendees	array[string]	No	List of attendee emails. Supports `%%email%%`
google_email	string	No	Specific Google account to use
reminders	array[object]	No	Reminders. Each: `{\"method\": \"email\"
visibility	string	No	`\"default\"`, `\"public\"`, or `\"private\"`
recurrence	object	No	Recurrence settings (create only). See below

Recurrence object (optional, create only):

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Description
enabled	boolean	Enable recurrence
frequency	string	`\"DAILY\"`, `\"WEEKLY\"`, `\"MONTHLY\"`, or `\"YEARLY\"`
count	integer	Number of occurrences
interval	integer	Every N days/weeks/months
by_day	array[string]	Day codes for weekly events: `\"MO\"`, `\"TU\"`, `\"WE\"`, `\"TH\"`, `\"FR\"`, `\"SA\"`, `\"SU\"`

Create event:

{\n    \"step_type\": \"GoogleCalendar\",\n    \"calendar_id\": \"primary\",\n    \"calendar_name\": \"Work Calendar\",\n    \"configuration\": {\n        \"operation\": \"create\",\n        \"event_title\": \"Call with %%first_name%%\",\n        \"event_description\": \"Auto-scheduled follow-up\",\n        \"start_datetime\": \"2026-03-01T10:00:00Z\",\n        \"end_datetime\": \"2026-03-01T11:00:00Z\",\n        \"time_zone\": \"Europe/Rome\",\n        \"attendees\": [\"%%email%%\"],\n        \"reminders\": [\n            {\"method\": \"popup\", \"minutes\": 30}\n        ]\n    }\n}\n\n

Update event:

{\n    \"step_type\": \"GoogleCalendar\",\n    \"calendar_id\": \"primary\",\n    \"configuration\": {\n        \"operation\": \"update\",\n        \"event_id\": \"%%EVENT_ID%%\",\n        \"event_title\": \"Updated: Call with %%first_name%%\"\n    }\n}\n\n

Delete event:

{\n    \"step_type\": \"GoogleCalendar\",\n    \"calendar_id\": \"primary\",\n    \"configuration\": {\n        \"operation\": \"delete\",\n        \"event_id\": \"%%EVENT_ID%%\"\n    }\n}\n\n

N8nWebhook

Sends a webhook to n8n.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
url	string (URL)	Yes	n8n webhook URL
method	string	No	HTTP method. Default: `POST`

{\n    \"step_type\": \"N8nWebhook\",\n    \"url\": \"https://n8n.example.com/webhook/abc-123\"\n}\n\n

TransformContactField

Transforms a contact field value (e.g., date formatting, JSON parsing).

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
input_field_code	string	Yes	Source custom field code
output_field_code	string	Yes	Destination custom field code
transformation_type	string	Yes	One of: `string_to_date`, `string_to_datetime`, `date_to_string`, `datetime_to_string`, `json_to_json`, `json_to_text`
date_format	string	No	Date format pattern. Required for date transformations. Uses format tokens: `DD` (day), `MM` (month), `YYYY` (year), `HH` (hour), `mm` (minute), `ss` (second). Examples: `\"DD/MM/YYYY\"`, `\"YYYY-MM-DD\"`, `\"DD/MM/YYYY HH:mm\"`
json_mapping	string	No	JSON mapping template for `json_to_json` and `json_to_text` transformations. A template string that extracts values from the source JSON field using dot-notation paths
json_input_example	string	No	Example JSON input for preview/testing purposes

Date transformation example:

{\n    \"step_type\": \"TransformContactField\",\n    \"input_field_code\": \"birth_date_text\",\n    \"output_field_code\": \"birth_date\",\n    \"transformation_type\": \"string_to_date\",\n    \"date_format\": \"DD/MM/YYYY\"\n}\n\n

JSON transformation example:

{\n    \"step_type\": \"TransformContactField\",\n    \"input_field_code\": \"webhook_response\",\n    \"output_field_code\": \"order_summary\",\n    \"transformation_type\": \"json_to_text\",\n    \"json_mapping\": \"Order #{{order.id}} - Total: {{order.total}}\"\n}\n\n

HubSpotWebhook

Sends a webhook to HubSpot.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
url	string (URL)	Yes	HubSpot webhook URL
method	string	No	HTTP method. Default: `POST`
payload_config	object	No	Payload configuration

{\n    \"step_type\": \"HubSpotWebhook\",\n    \"url\": \"https://api.hubapi.com/webhooks/v1/...\",\n    \"method\": \"POST\"\n}\n\n

GoHighLevelWebhook

Sends a webhook to GoHighLevel.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
url	string (URL)	Yes	GoHighLevel webhook URL
method	string	No	HTTP method. Default: `POST`

{\n    \"step_type\": \"GoHighLevelWebhook\",\n    \"url\": \"https://services.leadconnectorhq.com/hooks/...\"\n}\n\n

GoogleGmail

Sends an email or creates a draft via Gmail.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
configuration	object	No	Gmail configuration

Configuration fields:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
operation	string	Yes	`send_email` or `create_draft`
to	array[string]	Yes	Recipient email addresses
subject	string	Yes	Email subject
body	string	Yes	Email body (HTML supported)
cc	array[string]	No	CC recipients
bcc	array[string]	No	BCC recipients
from_name	string	No	Sender display name
reply_to	string	No	Reply-to address

{\n    \"step_type\": \"GoogleGmail\",\n    \"configuration\": {\n        \"operation\": \"send_email\",\n        \"to\": [\"customer@example.com\"],\n        \"subject\": \"Order Confirmation\",\n        \"body\": \"<h1 class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27;>Thank you!</h1><p class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27;>Your order has been confirmed.</p>\"\n    }\n}\n\n

UpdateDeal

Updates an existing deal associated with the contact.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
deal	object	No	Deal configuration

deal object

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
pipeline	integer	No	Pipeline ID
stage	integer	No	Stage ID within the pipeline
title	string	No	Deal title (supports dynamic fields, e.g., `\"John\"`)
value	string	No	Deal monetary value

{\n    \"step_type\": \"UpdateDeal\",\n    \"deal\": {\n        \"stage\": 3,\n        \"value\": \"5000\"\n    }\n}\n\n

CreateDeal

Creates a new deal. Same structure as UpdateDeal.

{\n    \"step_type\": \"CreateDeal\",\n    \"deal\": {\n        \"pipeline\": 1,\n        \"stage\": 1,\n        \"title\": \"New deal from John\",\n        \"value\": \"1000\"\n    }\n}\n\n

Voice

Initiates a Spoki Voice call.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
agent_id	string	Yes	Voice agent ID
agent_phonenumber_id	string	No	Phone number ID (auto-fetched if not provided)

{\n    \"step_type\": \"Voice\",\n    \"agent_id\": \"agent_abc123\"\n}\n\n

Trigger Types Reference

webhook_set

Creates a webhook trigger that starts the automation when called.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
name	string	Yes	Name of the webhook trigger
platform	string	Yes	Integration platform label (case-insensitive)

Available platform values:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Label	Description
`webhook`	Generic Webhook
`api`	API
`zapier`	Zapier
`make`	Make (Integromat)
`n8n`	n8n
`activecampaign`	Active Campaign
`hubspot`	HubSpot
`shopify`	Shopify
`woocommerce`	WooCommerce
`magento`	Magento
`prestashop`	PrestaShop
`pipedrive`	Pipedrive
`salesforce`	Salesforce
`gohighlevel`	GoHighLevel

{\n    \"webhook_set\": [\n        {\n            \"name\": \"Inbound Webhook\",\n            \"platform\": \"webhook\"\n        }\n    ]\n}\n\n

onfirstmessagestarter_set

Triggers the automation when a contact sends a first message.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
first_message_ever	boolean	No	If `true`, triggers only on the very first message the contact has ever sent. Default: `false`

{\n    \"onfirstmessagestarter_set\": [\n        {\n            \"first_message_ever\": true\n        }\n    ]\n}\n\n

fieldconditionstarter_set

Triggers the automation when a contact's custom field matches a condition.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
custom_field	integer	Yes	Custom field ID to monitor (must belong to your account)
value	string	No	Value to compare against
operator	string	No	Comparison operator: `\"=\"` (equal), `\"<\"` (before), `\"<=\"` (before or equal), `\">\"` (after), `\">=\"` (after or equal)
condition_type	integer	No	Condition type: `1` = Date condition
time	string	No	Time of day to check, in `HH:MM:SS` format (e.g., `\"09:00:00\"`)
time_delta	integer	No	Time offset in seconds relative to the matched date (e.g., `3600` = 1 hour after)
ignore_year	boolean	No	If `true`, ignores the year in date comparisons (useful for birthdays). Default: `true`

Example — trigger when custom field equals a value:

{\n    \"fieldconditionstarter_set\": [\n        {\n            \"custom_field\": 55,\n            \"value\": \"VIP\",\n            \"operator\": \"=\"\n        }\n    ]\n}\n\n

Example — trigger on a date field (e.g., birthday), ignoring year:

{\n    \"fieldconditionstarter_set\": [\n        {\n            \"custom_field\": 100,\n            \"operator\": \"=\",\n            \"condition_type\": 1,\n            \"time\": \"09:00:00\",\n            \"ignore_year\": true\n        }\n    ]\n}\n\n

Full Examples

Minimal — Automation with no steps

curl --location 'https://api.spoki.com/api/1/automations/' \\\n--header 'X-Spoki-Api-Key: {{Api-Key}}' \\\n--header 'Content-Type: application/json' \\\n--data '{\n    \"name\": \"Empty Automation\"\n}'\n\n

Automation with delay + template message

curl --location 'https://api.spoki.com/api/1/automations/' \\\n--header 'X-Spoki-Api-Key: {{Api-Key}}' \\\n--header 'Content-Type: application/json' \\\n--data '{\n    \"name\": \"Template Automation\",\n    \"steps\": [\n        {\n            \"step_type\": \"Delay\",\n            \"delay_seconds\": 3600\n        },\n        {\n            \"step_type\": \"TemplateMessage\",\n            \"template\": 456\n        }\n    ]\n}'\n\n

Automation with If/Else on contact name

curl --location 'https://api.spoki.com/api/1/automations/' \\\n--header 'X-Spoki-Api-Key: {{Api-Key}}' \\\n--header 'Content-Type: application/json' \\\n--data '{\n    \"name\": \"Conditional Automation\",\n    \"steps\": [\n        {\n            \"step_type\": \"Delay\",\n            \"delay_seconds\": 600\n        },\n        {\n            \"step_type\": \"IfElse\",\n            \"conditions\": {\n                \"and_conditions\": [\n                    {\n                        \"and_conditions\": [\n                            {\n                                \"key\": \"first_name\",\n                                \"condition\": \"contains\",\n                                \"value\": \"Alessandro\",\n                                \"metadata\": \"first_name\"\n                            }\n                        ]\n                    }\n                ]\n            }\n        },\n        {\n            \"step_type\": \"TemplateMessage\",\n            \"template\": 2550\n        }\n    ]\n}'\n\n

Automation with webhook trigger + tags + free message

curl --location 'https://api.spoki.com/api/1/automations/' \\\n--header 'X-Spoki-Api-Key: {{Api-Key}}' \\\n--header 'Content-Type: application/json' \\\n--data '{\n    \"name\": \"Welcome Flow\",\n    \"is_active\": true,\n    \"steps\": [\n        {\n            \"step_type\": \"Delay\",\n            \"delay_seconds\": 60\n        },\n        {\n            \"step_type\": \"FreeMessage\",\n            \"text\": \"Hello! Welcome to our service.\"\n        },\n        {\n            \"step_type\": \"AddTag\",\n            \"tag\": 123\n        }\n    ],\n    \"webhook_set\": [\n        {\n            \"name\": \"Inbound Webhook\",\n            \"platform\": \"webhook\"\n        }\n    ],\n    \"onfirstmessagestarter_set\": [\n        {\n            \"first_message_ever\": true\n        }\n    ]\n}'\n\n

Automation with automation groups

curl --location 'https://api.spoki.com/api/1/automations/' \\\n--header 'X-Spoki-Api-Key: {{Api-Key}}' \\\n--header 'Content-Type: application/json' \\\n--data '{\n    \"name\": \"Grouped Automation\",\n    \"automation_groups\": [1, 2],\n    \"steps\": [\n        {\n            \"step_type\": \"FreeMessage\",\n            \"text\": \"Hello from a grouped automation!\"\n        }\n    ]\n}'\n\n

Complete example — Multi-step with webhook, If/Else, tag, and sub-automation

curl --location 'https://api.spoki.com/api/1/automations/' \\\n--header 'X-Spoki-Api-Key: {{Api-Key}}' \\\n--header 'Content-Type: application/json' \\\n--data '{\n    \"name\": \"Complete Onboarding Flow\",\n    \"is_active\": true,\n    \"steps\": [\n        {\n            \"step_type\": \"Delay\",\n            \"delay_seconds\": 30\n        },\n        {\n            \"step_type\": \"FreeMessage\",\n            \"text\": \"Welcome! Let us get you set up.\"\n        },\n        {\n            \"step_type\": \"IfElse\",\n            \"conditions\": {\n                \"and_conditions\": [\n                    {\n                        \"and_conditions\": [\n                            {\n                                \"key\": \"email\",\n                                \"condition\": \"not_empty\",\n                                \"value\": \"\",\n                                \"metadata\": \"email\"\n                            }\n                        ]\n                    }\n                ]\n            }\n        },\n        {\n            \"step_type\": \"AddTag\",\n            \"tag\": 100\n        },\n        {\n            \"step_type\": \"Webhook\",\n            \"url\": \"https://api.example.com/new-lead\",\n            \"method\": \"POST\"\n        },\n        {\n            \"step_type\": \"SubAutomation\",\n            \"automation_to_start\": 5678\n        }\n    ],\n    \"onfirstmessagestarter_set\": [\n        {\n            \"first_message_ever\": true\n        }\n    ]\n}'\n\n

Complete example — IfElse with branching + SwitchCase routing

This example creates an automation with:

A template message
\n
An IfElse that checks if the contact has a first name:
\n
- True branch → two AddTag steps (main flow continues)
  \n
- False branch → two AddTag steps (via step_set)
  \n
\n
A SwitchCase that routes by language (Italiano, English, Español + default)
\n
A webhook
\n

curl --location 'https://api.spoki.com/api/1/automations/' \\\n--header 'X-Spoki-Api-Key: {{Api-Key}}' \\\n--header 'Content-Type: application/json' \\\n--data '{\n    \"name\": \"Branching Flow Example\",\n    \"is_active\": true,\n    \"steps\": [\n        {\n            \"step_type\": \"TemplateMessage\",\n            \"position\": 0,\n            \"template\": 2996\n        },\n        {\n            \"step_type\": \"IfElse\",\n            \"position\": 1,\n            \"conditions\": {\n                \"and_conditions\": [\n                    {\n                        \"and_conditions\": [\n                            {\n                                \"key\": \"first_name\",\n                                \"condition\": \"not_empty\",\n                                \"value\": \"\",\n                                \"metadata\": \"first_name\"\n                            }\n                        ]\n                    }\n                ]\n            },\n            \"step_set\": [\n                {\"step_type\": \"AddTag\", \"position\": 0, \"tag\": 200},\n                {\"step_type\": \"AddTag\", \"position\": 1, \"tag\": 201}\n            ]\n        },\n        {\n            \"step_type\": \"AddTag\",\n            \"position\": 2,\n            \"tag\": 100\n        },\n        {\n            \"step_type\": \"AddTag\",\n            \"position\": 3,\n            \"tag\": 101\n        },\n        {\n            \"step_type\": \"SwitchCase\",\n            \"position\": 4,\n            \"handled_conditions\": [\"IT\", \"EN\", \"ES\", \"DEFAULT_CASE_KEY\"],\n            \"key_metadata\": \"{\\\"casesName\\\":[\\\"Italiano\\\",\\\"English\\\",\\\"Español\\\",\\\"DEFAULT_CASE_KEY\\\"],\\\"key\\\":\\\"language\\\"}\"\n        },\n        {\n            \"step_type\": \"Webhook\",\n            \"position\": 5,\n            \"url\": \"https://api.example.com/webhook\",\n            \"method\": \"POST\"\n        }\n    ]\n}'\n\n

Flow breakdown:

Template (#0)\n    ↓\nIfElse (#1): first_name not empty?\n    ├─ TRUE  → AddTag 100 (#2) → AddTag 101 (#3) → SwitchCase (#4) → Webhook (#5)\n    └─ FALSE → AddTag 200 (step_set[0]) → AddTag 201 (step_set[1])\nSwitchCase (#4): language?\n    ├─ IT       → (Italiano branch)\n    ├─ EN       → (English branch)\n    ├─ ES       → (Español branch)\n    └─ DEFAULT  → (fallback branch)\n\n

Response

201 Created

{\n    \"id\": 12345,\n    \"name\": \"Welcome Flow\",\n    \"first_message_text\": \"Hello! Welcome to our service.\",\n    \"webhook_set\": [\n        {\n            \"id\": 678,\n            \"name\": \"Inbound Webhook\",\n            \"platform\": \"Webhook\",\n            \"link\": \"https://api.spoki.com/wh/ap/{uuid}/\"\n        }\n    ],\n    \"is_active\": true,\n    \"is_favorite\": false,\n    \"created_datetime\": \"2026-02-20T10:30:00Z\",\n    \"updated_datetime\": \"2026-02-20T10:30:00Z\",\n    \"updated_user\": null,\n    \"automation_groups\": []\n}\n\n

Error Responses

400 Bad Request — Invalid or missing required fields

{\n    \"error_code\": \"INVALID_REQUEST_BODY\",\n    \"detail\": {\n        \"steps\": {\n            \"step_0\": {\n                \"template\": [\"This field is required.\"]\n            }\n        }\n    }\n}\n\n

400 Bad Request — Missing step_type

{\n    \"error_code\": \"INVALID_REQUEST_BODY\",\n    \"detail\": {\n        \"steps\": [\"step_type is required for step at position 0\"]\n    }\n}\n\n

400 Bad Request — Resource belongs to another account

Steps that reference account-scoped resources (template, tag, list, custom_field, automation_to_start, role) are validated for ownership. If a resource ID does not belong to your account, the request is rejected.

{\n    \"error_code\": \"INVALID_REQUEST_BODY\",\n    \"detail\": {\n        \"template\": [\"Template with id 999 does not belong to your account.\"]\n    }\n}\n\n

This also applies to M2M fields (tags, lists, roles):

{\n    \"error_code\": \"INVALID_REQUEST_BODY\",\n    \"detail\": {\n        \"tags\": [\"Tag ids [55, 77] do not belong to your account.\"]\n    }\n}\n\n

403 Forbidden — Missing or invalid API key

{\n    \"detail\": \"Authentication credentials were not provided.\"\n}\n\n

Returns all dynamic fields (placeholders) used across an automation's steps. Use this to know which contact fields and custom fields are required when triggering the automation via API.

Endpoint

GET /api/1/automations/{id}/custom-fields-used/\n\n

Rate Limit: 60/min

Authentication

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Header	Required	Description
`x-spoki-api-key`	Yes	Your account API key

Path Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`id`	integer	The automation ID

Response

200 OK

{\n  \"raw_codes\": [\n    \"%%DATA_E_ORA_APPUNTAMENTO%%\",\n    \"%%FIRST_NAME%%\"\n  ],\n  \"contact_fields\": [\n    \"phone\",\n    \"first_name\"\n  ],\n  \"custom_fields\": [\n    {\n      \"id\": 188859,\n      \"label\": \"Data e ora appuntamento\",\n      \"field_type\": 2,\n      \"is_linked\": true,\n      \"code\": \"DATA_E_ORA_APPUNTAMENTO\",\n      \"example\": \"05/09/24\"\n    }\n  ],\n  \"static_custom_fields\": [\n    {\n      \"field_name\": \"PRODUCTO\",\n      \"value\": \"example product\",\n      \"step_id\": 12345\n    }\n  ]\n}\n\n

Response Fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Description
`raw_codes`	array of strings	All placeholder codes found in the automation steps (e.g. `%%FIRST_NAME%%`, `%%CUSTOM_FIELD%%`)
`contact_fields`	array of strings	Built-in contact fields used by the automation. Always includes `phone`. May also include `first_name`, `last_name`, `email`
`custom_fields`	array of objects	All custom field definitions referenced by the automation (from template placeholders)
`custom_fields[].id`	integer	Custom field ID
`custom_fields[].label`	string	Human-readable label
`custom_fields[].field_type`	integer	Field type: `1` = Text, `2` = Date, `3` = Number, `4` = URL
`custom_fields[].is_linked`	boolean	Whether the field is linked to an external source
`custom_fields[].code`	string	Field code (without `%%` delimiters)
`custom_fields[].example`	string	Example value for the field
`static_custom_fields`	array of objects	Custom fields used exclusively with a static (fixed) value across all steps. A field that is used statically in one step and dynamically in another is not included here
`static_custom_fields[].field_name`	string	The field code (e.g. `PRODUCTO`)
`static_custom_fields[].value`	string	The static value configured in the step
`static_custom_fields[].step_id`	integer	The ID of the step where this static value is set

404 Not Found

The automation does not exist or does not belong to your account.

429 Too Many Requests

Rate limit exceeded (5 requests per minute).

Example

cURL

curl -X GET \"https://app.spoki.it/api/1/automations/501754/custom-fields-used/\" \\\n  -H \"x-spoki-api-key: YOUR_API_KEY\"\n\n

Python

import requests\nresponse = requests.get(\n    \"https://app.spoki.it/api/1/automations/501754/custom-fields-used/\",\n    headers={\"x-spoki-api-key\": \"YOUR_API_KEY\"}\n)\ndata = response.json()\nprint(\"Required contact fields:\", data[\"contact_fields\"])\nprint(\"Custom fields:\", [f[\"label\"] for f in data[\"custom_fields\"]])\n\n

Notes

The phone field is always included in contact_fields regardless of automation content.
\n
Only active steps are analyzed.
\n
Only active custom fields are returned.
\n
Placeholders are extracted from: template messages, free messages, interactive messages, PayPal steps, and Stripe steps.
\n
static_custom_fields only includes fields that are never used dynamically (populated from contact) in any step of the automation. If the same field is static in one step and dynamic in another, it will appear only in custom_fields, not in static_custom_fields.
\n

\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"d4c9e9e1-781d-4cf8-a037-b2f92bd7f2fa","id":"d4c9e9e1-781d-4cf8-a037-b2f92bd7f2fa","name":"Automations","type":"folder"}},"urlObject":{"path":["api","1","automations","{{id}}","custom-fields-used",""],"host":["{{Base-URL}}"],"query":[],"variable":[]}},"response":[{"id":"39423cdd-5ae6-4a08-b446-7bd7894c77c2","name":"200 OK Copy","originalRequest":{"method":"GET","header":[{"key":"X-Spoki-Api-Key","value":"{{Api-Key}}","type":"text"}],"url":"{{Base-URL}}/api/1/automations/{{id}}/custom-fields-used/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.14.0 (Ubuntu)"},{"key":"Date","value":"Thu, 22 Dec 2022 13:59:22 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"412"},{"key":"Connection","value":"keep-alive"},{"key":"Allow","value":"GET, HEAD, OPTIONS"},{"key":"Vary","value":"Origin, Cookie"},{"key":"X-Frame-Options","value":"DENY"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Strict-Transport-Security","value":"max-age=31536000"}],"cookie":[],"responseTime":null,"body":"{\n \"raw_codes\": [\n \"%%DATA_E_ORA_APPUNTAMENTO%%\",\n \"%%FIRST_NAME%%\"\n ],\n \"contact_fields\": [\n \"phone\",\n \"first_name\"\n ],\n \"static_custom_fields\": [\n {\n \"field_name\": \"PRODUCTO\",\n \"value\": \"example product\",\n \"step_id\": 12345\n }\n ],\n \"custom_fields\": [\n {\n \"id\": 1234,\n \"label\": \"Data e ora appuntamento\",\n \"field_type\": 2,\n \"is_linked\": true,\n \"code\": \"DATA_E_ORA_APPUNTAMENTO\",\n \"example\": \"05/09/24\"\n }\n ]\n}"}],"_postman_id":"50b69da1-a8df-4127-8bdc-f7e42014dfec"}],"id":"d4c9e9e1-781d-4cf8-a037-b2f92bd7f2fa","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"id":"5ab49dd2-6e25-4f4b-96b1-a89dc04c2443","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"5cc1f4c6-269f-4228-b914-6fabe71e91b1","type":"text/javascript","exec":[""]}}],"_postman_id":"d4c9e9e1-781d-4cf8-a037-b2f92bd7f2fa","description":""},{"name":"Campaigns","item":[{"name":"List, search, and filter campaigns","id":"cc3fc38f-8155-4131-9d7d-1b84f9c179a2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"X-Spoki-Api-Key","value":"{{Api-Key}}","type":"text"}],"url":"{{Base-URL}}/api/1/campaigns/","description":"

Rate Limit: 5/min
Caching Policy: Some attributes will be cached

2 min

contacts_count

24h after the campaign is completed

automation_started, automation_completed, automation_failed, automation_valid_failed, automation_interacted_with, messages_sent, messages_received, messages_read, messages_failed

Retrieves a list of campaigns from the specified endpoint.

Response

The response will be a JSON object containing the following fields:

count: The total count of campaigns for the provided account.
\n
next: A link to the next page of results, if available.
\n
previous: A link to the previous page of results, if available.
\n
results: An array containing details of each campaign.
\n

Each campaign object in the results array includes the following fields:

id: The unique identifier of the campaign.
\n
name: The name of the campaign.
\n
status: The status of the campaign.
\n
- Draft
  \n
- Scheduled
  \n
- Processing
  \n
- Completed
  \n
\n
automation: Details of the associated automation, including its ID and name.
\n
lists: An array containing details of lists associated with the campaign, including their IDs, names, colors, creation datetime, and contact counts.
\n
scheduled_datetime: The datetime at which the campaign is scheduled.
\n
other_contacts: Additional contacts associated with the campaign.
\n
contacts_count: The total count of contacts associated with the campaign.
\n
automation_started: The count of automation processes started for the campaign.
\n
automation_completed: The count of automation processes completed for the campaign.
\n
automation_failed: The count of failed automation processes for the campaign.
\n
automation_valid_failed: The count of valid failed automation processes for the campaign.
\n
automation_interacted_with: The count of interactions with the automation for the campaign.
\n
messages_sent: The count of messages sent for the campaign.
\n
messages_received: The count of messages received for the campaign.
\n
messages_read: The count of messages read for the campaign.
\n
messages_failed: The count of failed messages for the campaign.
\n
created_datetime: The datetime at which the campaign was created.
\n

\n","urlObject":{"path":["api","1","campaigns",""],"host":["{{Base-URL}}"],"query":[{"disabled":true,"key":"scheduled_datetime_gte","value":"2024-01-01T00:00:00"},{"disabled":true,"key":"scheduled_datetime_lte","value":"2024-01-01T00:00:00"}],"variable":[]}},"response":[{"id":"aa83cd3c-d7ce-4a12-8e3f-114b4488ce45","name":"200 OK","originalRequest":{"method":"GET","header":[],"url":"{{Base-URL}}/api/1/campaigns/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 28 Aug 2023 12:17:17 GMT"},{"key":"Server","value":"WSGIServer/0.2 CPython/3.7.9"},{"key":"Content-Type","value":"application/json"},{"key":"Vary","value":"Accept, Origin, Cookie"},{"key":"Allow","value":"GET, POST, HEAD, OPTIONS"},{"key":"Server-Timing","value":"TimerPanel_utime;dur=2801.1810000000423;desc=\"User CPU time\", TimerPanel_stime;dur=593.042999999966;desc=\"System CPU time\", TimerPanel_total;dur=3394.2240000000083;desc=\"Total CPU time\", TimerPanel_total_time;dur=3741.213321685791;desc=\"Elapsed time\", SQLPanel_sql_time;dur=106.60886764526367;desc=\"SQL 33 queries\", CachePanel_total_time;dur=16.034841537475586;desc=\"Cache 4 Calls\""},{"key":"Content-Length","value":"2930"},{"key":"X-Frame-Options","value":"DENY"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"}],"cookie":[],"responseTime":null,"body":"{\n \"count\": 1,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n {\n \"id\": 35122,\n \"name\": \"MyCampaign\",\n \"status\": \"Scheduled\",\n \"automation\": {\n \"id\": 253226,\n \"name\": \"Lorem Automation\"\n },\n \"lists\": [\n {\n \"id\": 4238,\n \"name\": \"MyList\",\n \"color\": null,\n \"created_datetime\": \"2023-05-24T12:51:42.763583+02:00\",\n \"contacts_count\": 0\n }\n ],\n \"scheduled_datetime\": \"2023-08-25T15:30:00.218000+02:00\",\n \"other_contacts\": [],\n \"contacts_count\": 0,\n \"automation_started\": 0,\n \"automation_completed\": 0,\n \"automation_failed\": 0,\n \"automation_valid_failed\": 0,\n \"automation_interacted_with\": 0,\n \"messages_sent\": 0,\n \"messages_received\": 0,\n \"messages_read\": 0,\n \"messages_failed\": 0,\n \"created_datetime\": \"2023-08-25T10:47:19.635070+02:00\"\n }\n ]\n}"}],"_postman_id":"cc3fc38f-8155-4131-9d7d-1b84f9c179a2"},{"name":"Create campaign","id":"adb674d2-0129-48fb-b3ae-092185c11926","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"X-Spoki-Api-Key","value":"{{Api-Key}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"MyCampaign\",\n \"scheduled_datetime\": \"2024-08-28T10:00:00.000Z\",\n \"status\": \"Scheduled\",\n \"automation\": {{id}},\n \"lists\": [{{id}}],\n \"template\": {{id}}\n}","options":{"raw":{"language":"json"}}},"url":"{{Base-URL}}/api/1/campaigns/","description":"

Rate Limit: 5/min

You can decide to create a campaign based on an already existing automation or with a template.

If you create it by template you don't have to send the automation key in the request payload and viceversa.

When you create a campaign by template an automation will be automatically created by Spoki.

Possible Error Codes:

In case the body isn't correct:

{\n    \"field\": [\n        \"Error description.\"\n    ]\n}\n\n

In case the body is correct, other error code:

{\n    \"type\": \"https://app.spoki.it/errors/spoki::3004\",\n    \"title\": \"The request body is not correct\",\n    \"code\": \"spoki::3004\",\n    \"status\": 400,\n    \"datail\": \"Invalid automation_id specified.\"\n}\n\n

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Status	Code	Title	Datail
400	spoki::3004	The request body is not correct	The scheduled_datetime is valid but is not after now.
400	spoki::3004	The request body is not correct	Invalid scheduled_datetime. Send 'scheduled_datetime' in ISO 8601 format.Example: 2020-01-01T00:00:00.000Z\"
400	spoki::3004	The request body is not correct	Invalid or no status specified. Use 'status'
400	spoki::3004	The request body is not correct	Invalid or no automation specified. Use 'automation_id'
400	spoki::3004	The request body is not correct	Invalid or no lists specified. Use 'list_ids'.
400	spoki::3004	The request body is not correct	Invalid list_id specified
400	spoki::3004	The request body is not correct	Error adding a field to the body
400	spoki::3007	Invalid request header	Invalid or no account specified

","urlObject":{"path":["api","1","campaigns",""],"host":["{{Base-URL}}"],"query":[],"variable":[]}},"response":[{"id":"2d539ac7-6628-494a-b67c-fc2ebcedf9d2","name":"201 Created","originalRequest":{"method":"POST","header":[{"key":"X-Spoki-Api-Key","value":"{{Api-Key}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"name\": \"MyCampaign\",\n \"scheduled_datetime\": \"2024-08-28T10:00:00.000Z\",\n \"status\": \"Scheduled\",\n \"template\": {{id}},\n \"lists\": [{{id}}]\n}","options":{"raw":{"language":"json"}}},"url":"{{Base-URL}}/api/1/campaigns/"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 28 Aug 2023 12:25:37 GMT"},{"key":"Server","value":"WSGIServer/0.2 CPython/3.7.9"},{"key":"Content-Type","value":"application/json"},{"key":"Vary","value":"Accept, Origin, Cookie"},{"key":"Allow","value":"GET, POST, HEAD, OPTIONS"},{"key":"Server-Timing","value":"TimerPanel_utime;dur=1296.68700000002;desc=\"User CPU time\", TimerPanel_stime;dur=267.5800000000663;desc=\"System CPU time\", TimerPanel_total;dur=1564.2670000000862;desc=\"Total CPU time\", TimerPanel_total_time;dur=1593.4910774230957;desc=\"Elapsed time\", SQLPanel_sql_time;dur=29.886484146118164;desc=\"SQL 9 queries\", CachePanel_total_time;dur=4.533052444458008;desc=\"Cache 4 Calls\""},{"key":"Content-Length","value":"184"},{"key":"X-Frame-Options","value":"DENY"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 12121223,\n \"name\": \"MyCampaign\",\n \"status\": \"Scheduled\",\n \"automation\": 2524,\n \"lists\": [\n 48\n ],\n \"scheduled_datetime\": \"2024-08-28T10:00:00+02:00\",\n \"created_datetime\": \"2023-08-28T14:25:37.316419+02:00\"\n}"}],"_postman_id":"adb674d2-0129-48fb-b3ae-092185c11926"},{"name":"Retrieve campaign","id":"6a4b6b02-7dce-42e2-b21d-aab39c666543","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"X-Spoki-Api-Key","value":"{{Api-Key}}","type":"text"}],"url":"{{Base-URL}}/api/1/campaigns/{{id}}/","description":"

Rate Limit: 5/min
Caching Policy: Some attributes will be cached.

\n","urlObject":{"path":["api","1","campaigns","{{id}}",""],"host":["{{Base-URL}}"],"query":[],"variable":[]}},"response":[{"id":"04c8e232-020f-4211-a682-346235d95f3f","name":"200 OK","originalRequest":{"method":"GET","header":[{"key":"X-Spoki-Api-Key","value":"{{Api-Key}}","type":"text"}],"url":"{{Base-URL}}/api/1/campaigns/{{id}}/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.14.0 (Ubuntu)"},{"key":"Date","value":"Fri, 25 Aug 2023 08:24:08 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"604"},{"key":"Connection","value":"keep-alive"},{"key":"Allow","value":"GET, PUT, PATCH, DELETE, HEAD, OPTIONS"},{"key":"Vary","value":"Origin, Cookie"},{"key":"X-Frame-Options","value":"DENY"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Strict-Transport-Security","value":"max-age=31536000"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 12121223,\n \"name\": \"MyCampaign\",\n \"status\": 4,\n \"automation\": {\n \"id\": 11556237,\n \"name\": \"Lorem Automazione\"\n },\n \"lists\": [\n {\n \"id\": 4623451,\n \"name\": \"MyList\",\n \"color\": null,\n \"created_datetime\": \"2023-08-09T15:38:57.760934+02:00\",\n \"contacts_count\": 3\n }\n ],\n \"scheduled_datetime\": \"2023-08-09T16:20:00.308000+02:00\",\n \"other_contacts\": [],\n \"contacts_count\": 3,\n \"automation_started\": 0,\n \"automation_completed\": 3,\n \"automation_failed\": 0,\n \"automation_valid_failed\": 0,\n \"automation_interacted_with\": 2,\n \"messages_sent\": 0,\n \"messages_received\": 3,\n \"messages_read\": 0,\n \"messages_failed\": 0,\n \"created_datetime\": \"2023-08-09T16:18:13.394228+02:00\"\n}"}],"_postman_id":"6a4b6b02-7dce-42e2-b21d-aab39c666543"},{"name":"Update campaign","id":"7f6fe06c-511c-4c86-97b3-39ecfbdb8c3f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"PATCH","header":[{"key":"X-Spoki-Api-Key","value":"{{Api-Key}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"MyCampaign Updated\",\n \"scheduled_datetime\": \"2024-08-29T10:00:00.000Z\",\n \"status\": \"Scheduled\",\n \"automation\": {{id}},\n \"lists\": [{{id}}]\n}","options":{"raw":{"language":"json"}}},"url":"{{Base-URL}}/api/1/campaigns/{{id}}/","description":"

Rate Limit: 5/min

Possible Error Codes:

In case the body isn't correct:

{\n    \"field\": [\n        \"Error description.\"\n    ]\n}\n\n

In case the body is correct, other error code:

{\n    \"type\": \"https://app.spoki.it/errors/spoki::3004\",\n    \"title\": \"The request body is not correct\",\n    \"code\": \"spoki::3004\",\n    \"status\": 400,\n    \"datail\": \"Invalid automation_id specified.\"\n}\n\n

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Status	Code	Title	Datail
400	spoki::3004	The request body is not correct	The scheduled_datetime is valid but is not after now.
400	spoki::3004	The request body is not correct	Invalid scheduled_datetime. Send 'scheduled_datetime' in ISO 8601 format.Example: 2020-01-01T00:00:00.000Z\"
400	spoki::3004	The request body is not correct	Invalid or no status specified. Use 'status'
400	spoki::3004	The request body is not correct	Invalid automation_id specified
400	spoki::3004	The request body is not correct	Invalid status. The campaign is not in a valid state to be updated.
400	spoki::3004	The request body is not correct	Invalid list_id specified
400	spoki::3007	Invalid request header	Invalid or no account specified

","urlObject":{"path":["api","1","campaigns","{{id}}",""],"host":["{{Base-URL}}"],"query":[],"variable":[]}},"response":[{"id":"a64da7dc-dedb-4f78-a9e4-d5d52478b2cc","name":"200 OK","originalRequest":{"method":"PATCH","header":[{"key":"X-Spoki-Api-Key","value":"{{Api-Key}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"name\": \"MyCampaign Updated\",\n \"scheduled_datetime\": \"2024-08-29T10:00:00.000Z\",\n \"status\": \"Scheduled\",\n \"automation\": {{id}},\n \"lists\": [{{id}}]\n}","options":{"raw":{"language":"json"}}},"url":"{{Base-URL}}/api/1/campaigns/{{id}}/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 28 Aug 2023 12:26:21 GMT"},{"key":"Server","value":"WSGIServer/0.2 CPython/3.7.9"},{"key":"Content-Type","value":"application/json"},{"key":"Vary","value":"Accept, Origin, Cookie"},{"key":"Allow","value":"GET, PUT, PATCH, DELETE, HEAD, OPTIONS"},{"key":"Server-Timing","value":"TimerPanel_utime;dur=1329.4760000001133;desc=\"User CPU time\", TimerPanel_stime;dur=230.733999999984;desc=\"System CPU time\", TimerPanel_total;dur=1560.2100000000974;desc=\"Total CPU time\", TimerPanel_total_time;dur=1530.2419662475586;desc=\"Elapsed time\", SQLPanel_sql_time;dur=6.609678268432617;desc=\"SQL 9 queries\", CachePanel_total_time;dur=3.7584304809570312;desc=\"Cache 4 Calls\""},{"key":"Content-Length","value":"192"},{"key":"X-Frame-Options","value":"DENY"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 12121223,\n \"name\": \"MyCampaign Updated\",\n \"status\": \"Scheduled\",\n \"automation\": 2524,\n \"lists\": [\n 48\n ],\n \"scheduled_datetime\": \"2024-08-29T10:00:00+02:00\",\n \"created_datetime\": \"2023-08-28T14:25:37.316419+02:00\"\n}"}],"_postman_id":"7f6fe06c-511c-4c86-97b3-39ecfbdb8c3f"},{"name":"Delete campaign","id":"113c4069-d044-4932-9881-1170e16d19c0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"DELETE","header":[{"key":"X-Spoki-Api-Key","value":"{{Api-Key}}","type":"text"}],"url":"{{Base-URL}}/api/1/campaigns/{{id}}/","description":"

Rate Limit: 5/min

Possible Error Codes:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Status	Code	Title	Datail
403	spoki::403	Access denied	You can't delete a campaign while it's processing
400	spoki::3007	Invalid request header	Invalid or no account specified

","urlObject":{"path":["api","1","campaigns","{{id}}",""],"host":["{{Base-URL}}"],"query":[],"variable":[]}},"response":[{"id":"4dae59ba-0797-49a5-a6a7-4772c73a7a62","name":"204 No Content","originalRequest":{"method":"DELETE","header":[{"key":"X-Spoki-Api-Key","value":"{{Api-Key}}","type":"text"}],"url":"{{Base-URL}}/api/1/campaigns/{{id}}/"},"status":"No Content","code":204,"_postman_previewlanguage":"plain","header":[{"key":"Date","value":"Mon, 28 Aug 2023 12:26:38 GMT"},{"key":"Server","value":"WSGIServer/0.2 CPython/3.7.9"},{"key":"Vary","value":"Accept, Origin, Cookie"},{"key":"Allow","value":"GET, PUT, PATCH, DELETE, HEAD, OPTIONS"},{"key":"Server-Timing","value":"TimerPanel_utime;dur=1070.9779999999682;desc=\"User CPU time\", TimerPanel_stime;dur=224.4150000000218;desc=\"System CPU time\", TimerPanel_total;dur=1295.39299999999;desc=\"Total CPU time\", TimerPanel_total_time;dur=1268.4416770935059;desc=\"Elapsed time\", SQLPanel_sql_time;dur=18.60809326171875;desc=\"SQL 6 queries\", CachePanel_total_time;dur=6.557226181030273;desc=\"Cache 4 Calls\""},{"key":"Content-Length","value":"0"},{"key":"X-Frame-Options","value":"DENY"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"}],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"113c4069-d044-4932-9881-1170e16d19c0"}],"id":"aaccb7c7-a76c-4fe3-82c9-18165837d222","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"id":"80e404ff-9b36-4af5-b381-528f2a11cc4b","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"8eee7611-fbc0-40e7-aa2c-5536c8e7064b","type":"text/javascript","exec":[""]}}],"_postman_id":"aaccb7c7-a76c-4fe3-82c9-18165837d222","description":""},{"name":"Contacts","item":[{"name":"List, search, and filter contacts","id":"fb468cb2-73fe-4777-ae4b-d952eb103f5b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"X-Spoki-Api-Key","value":"{{Api-Key}}","type":"text"}],"url":"{{Base-URL}}/api/1/contacts/","description":"

Rate Limit: 120/min

\n","urlObject":{"path":["api","1","contacts",""],"host":["{{Base-URL}}"],"query":[{"disabled":true,"description":{"content":"

Search in: 'phone', 'email', 'first_name', 'last_name', 'language', 'notes'

\n","type":"text/plain"},"key":"search","value":""},{"disabled":true,"description":{"content":"

Filter by tag id

\n","type":"text/plain"},"key":"tag","value":""},{"disabled":true,"description":{"content":"

true | false\nGet blocked contacts only

\n","type":"text/plain"},"key":"is_blocked","value":""},{"disabled":true,"description":{"content":"

e.g. john.doe@domain.com

\n","type":"text/plain"},"key":"email","value":null},{"disabled":true,"description":{"content":"

e.g. +393331234567

\n","type":"text/plain"},"key":"phone","value":null},{"disabled":true,"description":{"content":"

e.g. 'en'

\n","type":"text/plain"},"key":"language","value":null},{"disabled":true,"description":{"content":"

e.g. 'John'

\n","type":"text/plain"},"key":"first_name","value":null},{"disabled":true,"description":{"content":"

e.g. 'Doe'

\n","type":"text/plain"},"key":"last_name","value":null}],"variable":[]}},"response":[{"id":"dde3cd67-22a2-4a7b-a213-4db0a775cd44","name":"200 OK","originalRequest":{"method":"GET","header":[{"key":"X-Spoki-Api-Key","value":"{{Api-Key}}"}],"url":"{{Base-URL}}/api/1/contacts/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.14.0 (Ubuntu)"},{"key":"Date","value":"Thu, 15 Sep 2022 13:14:03 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"4939"},{"key":"Connection","value":"keep-alive"},{"key":"Allow","value":"GET, HEAD, OPTIONS"},{"key":"Vary","value":"Origin, Cookie"},{"key":"X-Frame-Options","value":"DENY"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Strict-Transport-Security","value":"max-age=31536000"}],"cookie":[],"responseTime":null,"body":"{\n \"count\": 1,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n {\n \"id\": 1091234,\n \"first_name\": \"Mario\",\n \"last_name\": \"Rossi\",\n \"phone\": \"+39333123456789\",\n \"email\": \"mario.rossi@domain.com\",\n \"language\": \"it\",\n \"has_invalid_phone\": false,\n \"chat_link\": \"https://spoki.app/chats/DhxyQBtLMaqy0myzqnap\",\n \"created_datetime\": \"2021-04-19T16:24:02.567450+02:00\",\n \"contactfield_set\": [ \n {\n \"id\": 937944,\n \"field\": 152,\n \"visual_code\": \"%%WEBSITE%%\",\n \"value\": \"https://mywebsite.com\",\n \"value_datetime\": null\n }\n ],\n \"tag_set\": [\n {\n \"id\": 62,\n \"name\": \"To Reply\",\n \"color\": \"#16d46d\",\n \"order\": 2\n }\n ],\n \"list_set\": [\n {\n \"id\": 1234,\n \"name\": \"Prova Demo\",\n \"color\": null,\n \"created_datetime\": \"2022-03-18T10:16:45.040626+01:00\",\n \"contacts_count\": 3\n }\n ]\n }\n ]\n}"}],"_postman_id":"fb468cb2-73fe-4777-ae4b-d952eb103f5b"},{"name":"Sync contacts","id":"0ff9a650-b4cb-4f6b-8b91-8b4a45c44c74","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"X-Spoki-Api-Key","value":"{{Api-Key}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n {\n \"phone\": \"{{phone}}\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"email\": \"john.doe@domain.com\",\n \"language\": \"en\",\n \"custom_fields\": {\n \"ORDER_ID\": \"1234\"\n }\n }\n]","options":{"raw":{"language":"json"}}},"url":"{{Base-URL}}/api/1/contacts/sync_all/","description":"

Rate Limit: 1/min

Note:

Do not update the contact using this API before initiating an automation for it. The contact will be automatically updated when the 'Start automation' API is called.

Possible Error Codes:

In case the body isn't correct:

{\n    \"field\": [\n        \"Error description.\"\n    ]\n}\n\n

In case the body is correct, other error code:

{\n    \"type\": \"https://app.spoki.it/errors/spoki::3004\",\n    \"title\": \"The request body is not correct\",\n    \"code\": \"spoki::3004\",\n    \"status\": 400,\n    \"datail\": \"Too many contacts. Max 500 allowed.\"\n}\n\n

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Status	Code	Title	Datail
400	spoki::3004	The request body is not correct	Too many contacts. Max 500 allowed.
400	spoki::3007	Invalid request header	Invalid or no account specified

","urlObject":{"path":["api","1","contacts","sync_all",""],"host":["{{Base-URL}}"],"query":[],"variable":[]}},"response":[{"id":"93b589ee-e0b1-4bd2-b455-88ff5e41e048","name":"200 OK","originalRequest":{"method":"POST","header":[{"key":"X-Spoki-Api-Key","value":"{{Api-Key}}","type":"text"}],"body":{"mode":"raw","raw":"[\n {\n \"phone\": \"{{phone}}\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"email\": \"john.doe@domain.com\",\n \"language\": \"en\",\n \"contactfield_set\": [\n {\n \"field\": 14,\n \"value\": \"Milano\"\n }\n ]\n }\n]","options":{"raw":{"language":"json"}}},"url":"{{Base-URL}}/api/1/contacts/sync_all/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.14.0 (Ubuntu)"},{"key":"Date","value":"Thu, 15 Sep 2022 15:33:58 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"13"},{"key":"Connection","value":"keep-alive"},{"key":"Allow","value":"POST, OPTIONS"},{"key":"Vary","value":"Origin, Cookie"},{"key":"X-Frame-Options","value":"DENY"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Strict-Transport-Security","value":"max-age=31536000"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [],\n \"contacts\": [\n {\n \"id\": 1091234,\n \"first_name\": \"Mario\",\n \"last_name\": \"Rossi\",\n \"phone\": \"+39333123456789\",\n \"email\": \"mario.rossi@domain.com\",\n \"has_invalid_phone\": false,\n \"language\": \"it\",\n \"chat_link\": \"https://spoki.app/chats/DhxyQBtLMaqy0myzqnap\"\n }\n ]\n}"}],"_postman_id":"0ff9a650-b4cb-4f6b-8b91-8b4a45c44c74"},{"name":"Add Operator","id":"cff00c66-08be-43c1-b51b-e5c25bdbd46c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"X-Spoki-Api-Key","value":"{{Api-Key}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"email\": \"john.doe@domain.com\"\n}","options":{"raw":{"language":"json"}}},"url":"{{Base-URL}}/api/1/contacts/{{id}}/add_operator/","description":"

Rate Limit: 5/min

Assign an operator to the contact, so its chat.

Before the assignment the User must be intived to join the account form the Spoki Platform (https://spoki.app/users-and-roles).

Possible Error Codes:

In case the body isn't correct:

{\n    \"field\": [\n        \"Error description.\"\n    ]\n}\n\n

In case the body is correct, other error code:

{\n    \"type\": \"https://app.spoki.it/errors/spoki::3004\",\n    \"title\": \"The request body is not correct\",\n    \"code\": \"spoki::3004\",\n    \"status\": 400,\n    \"datail\": \"Invalid data type'\"\n}\n\n

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Status	Code	Title	Datail
400	spoki::3004	The request body is not correct	Invalid data type
400	spoki::3004	The request body is not correct	No email specified
400	spoki::3004	The request body is not correct	No operator found with this email
400	spoki::3007	Invalid request header	Invalid or no account specified

","urlObject":{"path":["api","1","contacts","{{id}}","add_operator",""],"host":["{{Base-URL}}"],"query":[],"variable":[]}},"response":[{"id":"d0f854c7-362e-4c4c-b773-0e1e21519f70","name":"200 OK","originalRequest":{"method":"POST","header":[{"key":"X-Spoki-Api-Key","value":"{{Api-Key}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"email\": \"john.doe@domain.com\"\n}","options":{"raw":{"language":"json"}}},"url":"{{Base-URL}}/api/1/contacts/{{id}}/add_operator/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.18.0 (Ubuntu)"},{"key":"Date","value":"Tue, 16 Jul 2024 09:42:31 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"2"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept, origin, Accept-Language, Cookie"},{"key":"Allow","value":"POST, OPTIONS"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Language","value":"en"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"Strict-Transport-Security","value":"max-age=31536000"}],"cookie":[],"responseTime":null,"body":"{}"}],"_postman_id":"cff00c66-08be-43c1-b51b-e5c25bdbd46c"},{"name":"Remove Operator","id":"570ba401-d857-4ade-926e-110f2fe56f9c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"X-Spoki-Api-Key","value":"{{Api-Key}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"email\": \"john.doe@domain.com\"\n}","options":{"raw":{"language":"json"}}},"url":"{{Base-URL}}/api/1/contacts/{{id}}/remove_operator/","description":"

Rate Limit: 5/min

Possible Error Codes:

In case the body isn't correct:

{\n    \"field\": [\n        \"Error description.\"\n    ]\n}\n\n

In case the body is correct, other error code:

{\n    \"type\": \"https://app.spoki.it/errors/spoki::3004\",\n    \"title\": \"The request body is not correct\",\n    \"code\": \"spoki::3004\",\n    \"status\": 400,\n    \"datail\": \"Invalid data type'\"\n}\n\n

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Status	Code	Title	Datail
400	spoki::3004	The request body is not correct	Invalid data type
400	spoki::3004	The request body is not correct	No email specified
400	spoki::3004	The request body is not correct	No operator found with this email
400	spoki::3007	Invalid request header	Invalid or no account specified

","urlObject":{"path":["api","1","contacts","{{id}}","remove_operator",""],"host":["{{Base-URL}}"],"query":[],"variable":[]}},"response":[{"id":"ed2375d1-ead9-40ea-b9b6-bc0054756732","name":"200 OK","originalRequest":{"method":"POST","header":[{"key":"X-Spoki-Api-Key","value":"{{Api-Key}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"email\": \"john.doe@domain.com\"\n}","options":{"raw":{"language":"json"}}},"url":"{{Base-URL}}/api/1/contacts/{{id}}/remove_operator/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.18.0 (Ubuntu)"},{"key":"Date","value":"Tue, 16 Jul 2024 09:42:59 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"2"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept, origin, Accept-Language, Cookie"},{"key":"Allow","value":"POST, OPTIONS"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Language","value":"en"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"Strict-Transport-Security","value":"max-age=31536000"}],"cookie":[],"responseTime":null,"body":"{}"}],"_postman_id":"570ba401-d857-4ade-926e-110f2fe56f9c"},{"name":"Create or update contact","id":"ffd54183-71c1-47e5-808b-66e2d1a92ef1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"X-Spoki-Api-Key","value":"{{Api-Key}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"phone\": \"{{phone}}\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"email\": \"john.doe@domain.com\",\n \"language\": \"en\",\n \"custom_fields\": {\n \"WEBSITE\": \"https://mywebsite.com\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{Base-URL}}/api/1/contacts/sync/","description":"

Rate Limit: 120/min

Note:

If you need to update multiple contacts use \"Sync contacts\"
\n
Do not update the contact using this API before initiating an automation for it. The contact will be automatically updated when the 'Start automation' API is called.
\n

\n","urlObject":{"path":["api","1","contacts","sync",""],"host":["{{Base-URL}}"],"query":[],"variable":[]}},"response":[{"id":"22d6794a-c886-4d5a-b1ee-fcc93fef0372","name":"200 OK","originalRequest":{"method":"POST","header":[{"key":"X-Spoki-Api-Key","value":"{{Api-Key}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"phone\": \"{{phone}}\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"email\": \"john.doe@domain.com\",\n \"language\": \"en\",\n \"custom_fields\": {}\n}","options":{"raw":{"language":"json"}}},"url":"{{Base-URL}}/api/1/contacts/sync/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.14.0 (Ubuntu)"},{"key":"Date","value":"Thu, 15 Sep 2022 15:34:36 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"154"},{"key":"Connection","value":"keep-alive"},{"key":"Allow","value":"POST, OPTIONS"},{"key":"Vary","value":"Origin, Cookie"},{"key":"X-Frame-Options","value":"DENY"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Strict-Transport-Security","value":"max-age=31536000"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 1091234,\n \"first_name\": \"Mario\",\n \"last_name\": \"Rossi\",\n \"phone\": \"+39333123456789\",\n \"email\": \"mario.rossi@domain.com\",\n \"has_invalid_phone\": false,\n \"language\": \"it\",\n \"chat_link\": \"https://spoki.app/chats/DhxyQBtLMaqy0myzqnap\"\n}"}],"_postman_id":"ffd54183-71c1-47e5-808b-66e2d1a92ef1"},{"name":"Retrieve contact","id":"db498140-6894-48e2-9dfb-9ccc5c9c9987","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"X-Spoki-Api-Key","value":"{{Api-Key}}","type":"text"}],"url":"{{Base-URL}}/api/1/contacts/{{id}}/","description":"

Rate Limit: 120/min

\n","urlObject":{"path":["api","1","contacts","{{id}}",""],"host":["{{Base-URL}}"],"query":[],"variable":[]}},"response":[{"id":"b555bdfa-e33a-4bab-add9-3b2f1c69b0b6","name":"200 OK","originalRequest":{"method":"GET","header":[{"key":"X-Spoki-Api-Key","value":"{{Api-Key}}"}],"url":"{{Base-URL}}/api/1/contacts/{{id}}/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.14.0 (Ubuntu)"},{"key":"Date","value":"Thu, 15 Sep 2022 15:36:26 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"797"},{"key":"Connection","value":"keep-alive"},{"key":"Allow","value":"GET, PUT, PATCH, DELETE, HEAD, OPTIONS"},{"key":"Vary","value":"Origin, Cookie"},{"key":"X-Frame-Options","value":"DENY"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Strict-Transport-Security","value":"max-age=31536000"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 1091234,\n \"first_name\": \"Mario\",\n \"last_name\": \"Rossi\",\n \"phone\": \"+393337981329\",\n \"email\": \"mario.rossi@domain.com\",\n \"language\": \"it\",\n \"has_invalid_phone\": false,\n \"chat_link\": \"https://spoki.app/chats/DhxyQBtLMaqy0myzqnap\",\n \"created_datetime\": \"2021-04-19T16:24:02.567450+02:00\",\n \"contactfield_set\": [\n {\n \"id\": 937944,\n \"field\": 152,\n \"visual_code\": \"%%WEBSITE%%\",\n \"value\": \"https://mywebsite.com\",\n \"value_datetime\": null\n }\n ],\n \"tag_set\": [\n {\n \"id\": 62,\n \"name\": \"To Reply\",\n \"color\": \"#16d46d\",\n \"order\": 2\n }\n ],\n \"list_set\": [\n {\n \"id\": 1809,\n \"name\": \"Prova Demo\",\n \"color\": null,\n \"created_datetime\": \"2022-03-18T10:16:45.040626+01:00\",\n \"contacts_count\": 3\n }\n ]\n}"}],"_postman_id":"db498140-6894-48e2-9dfb-9ccc5c9c9987"},{"name":"Update contact","id":"8645d84a-ae08-40c4-a34f-0cd843c3dfae","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"PATCH","header":[{"key":"X-Spoki-Api-Key","value":"{{Api-Key}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"phone\": \"{{phone}}\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"email\": \"john.doe@domain.com\",\n \"language\": \"en\",\n \"custom_fields\": {\n \"WEBSITE\": \"https://mywebsite.com\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{Base-URL}}/api/1/contacts/{{id}}/","description":"

Rate Limit: 120/min

\n","urlObject":{"path":["api","1","contacts","{{id}}",""],"host":["{{Base-URL}}"],"query":[],"variable":[]}},"response":[{"id":"08574f89-fa14-48e3-9cc0-f9c5e0b5263a","name":"200 OK","originalRequest":{"method":"PATCH","header":[{"key":"X-Spoki-Api-Key","value":"{{Api-Key}}"}],"body":{"mode":"raw","raw":"{\n \"phone\": \"{{phone}}\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"email\": \"john.doe@domain.com\",\n \"language\": \"en\"\n}","options":{"raw":{"language":"json"}}},"url":"{{Base-URL}}/api/1/contacts/{{id}}/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.14.0 (Ubuntu)"},{"key":"Date","value":"Wed, 21 Jun 2023 13:06:24 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"527"},{"key":"Connection","value":"keep-alive"},{"key":"Allow","value":"GET, PUT, PATCH, DELETE, HEAD, OPTIONS"},{"key":"Vary","value":"Origin, Cookie"},{"key":"X-Frame-Options","value":"DENY"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Strict-Transport-Security","value":"max-age=31536000"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 1091234,\n \"first_name\": \"Mario\",\n \"last_name\": \"Rossi\",\n \"phone\": \"+39333123456789\",\n \"email\": \"mario.rossi@domain.com\",\n \"language\": \"it\",\n \"contactfield_set\": [\n {\n \"id\": 937944,\n \"field\": 152,\n \"visual_code\": \"%%WEBSITE%%\",\n \"value\": \"https://mywebsite.com\",\n \"value_datetime\": null\n }\n ],\n \"chat_link\": \"https://spoki.app/chats/DhxyQBtLMaqy0myzqnap\"\n}"}],"_postman_id":"8645d84a-ae08-40c4-a34f-0cd843c3dfae"},{"name":"Delete contact","id":"5b38eb15-b5b7-4b48-a463-ee831fa5b1f9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"DELETE","header":[{"key":"X-Spoki-Api-Key","value":"{{Api-Key}}","type":"text"}],"url":"{{Base-URL}}/api/1/contacts/{{id}}/","description":"

Rate Limit: 120/min

\n","urlObject":{"path":["api","1","contacts","{{id}}",""],"host":["{{Base-URL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"5b38eb15-b5b7-4b48-a463-ee831fa5b1f9"},{"name":"Block Contact","id":"6df0a8d2-0ba0-4228-b2d2-b3d89c56df6c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"is_blocked\": true\n}","options":{"raw":{"language":"json"}}},"url":"{{Base-URL}}/api/1/contacts/{{id}}/","description":"

Rate Limit: 120/min

\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"83340f76-58e1-4fa3-a7d3-ae639b786d25","id":"83340f76-58e1-4fa3-a7d3-ae639b786d25","name":"Contacts","type":"folder"}},"urlObject":{"path":["api","1","contacts","{{id}}",""],"host":["{{Base-URL}}"],"query":[{"key":"is_blocked","value":"true"},{"disabled":true,"key":"","value":""}],"variable":[]}},"response":[],"_postman_id":"1c170ca3-6ad4-48d0-bf04-bf9213c3ea44"}],"id":"83340f76-58e1-4fa3-a7d3-ae639b786d25","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"id":"78572fa5-6b93-4270-b1fe-fa186f6ab202","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"dbb6c49b-3874-4475-9861-91665c07ac9b","type":"text/javascript","exec":[""]}}],"_postman_id":"83340f76-58e1-4fa3-a7d3-ae639b786d25","description":""},{"name":"Custom Fields","item":[{"name":"List, search, and filter custom fields","id":"b69f83ad-a10f-473f-8b41-bf3711ee9667","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"X-Spoki-Api-Key","value":"{{Api-Key}}","type":"text"}],"url":"{{Base-URL}}/api/1/custom-fields/","description":"

Rate Limit: 5/min

\n","urlObject":{"path":["api","1","custom-fields",""],"host":["{{Base-URL}}"],"query":[{"disabled":true,"description":{"content":"

You can search by: 'label', 'code'

\n","type":"text/plain"},"key":"search","value":null}],"variable":[]}},"response":[],"_postman_id":"b69f83ad-a10f-473f-8b41-bf3711ee9667"},{"name":"Create custom field","id":"f065b9bf-6c6d-47ed-8552-985f610065bc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"X-Spoki-Api-Key","value":"{{Api-Key}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"label\": \"MY_FIELD\",\n \"code\": \"MY_FIELD\", \n \"field_type\": 1,\n \"example\": \"Lorem ipsum\"\n}","options":{"raw":{"language":"json"}}},"url":"{{Base-URL}}/api/1/custom-fields/","description":"

Rate Limit: 5/min

Field Types:
TEXT = 1
DATE = 2
DATETIME = 3

Do not use this API to create reserved fields:
FIRST_NAME, FIRSTNAME, LAST_NAME, LASTNAME, EMAIL, PHONE, ACCOUNT_NAME, LANGUAGE

\n","urlObject":{"path":["api","1","custom-fields",""],"host":["{{Base-URL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"f065b9bf-6c6d-47ed-8552-985f610065bc"},{"name":"Retrieve custom field","id":"21c9bf54-5dd6-4f12-9edf-655e3c676ad6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"X-Spoki-Api-Key","value":"{{Api-Key}}","type":"text"}],"url":"{{Base-URL}}/api/1/custom-fields/{{id}}/","description":"

Rate Limit: 5/min

\n","urlObject":{"path":["api","1","custom-fields","{{id}}",""],"host":["{{Base-URL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"21c9bf54-5dd6-4f12-9edf-655e3c676ad6"},{"name":"Update custom field","id":"af88d4f4-28dc-4821-97c5-dd89c72711e8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"PATCH","header":[{"key":"X-Spoki-Api-Key","value":"{{Api-Key}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"label\": \"TestField\"\n}","options":{"raw":{"language":"json"}}},"url":"{{Base-URL}}/api/1/custom-fields/{{id}}/","description":"

Rate Limit: 5/min

\n","urlObject":{"path":["api","1","custom-fields","{{id}}",""],"host":["{{Base-URL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"af88d4f4-28dc-4821-97c5-dd89c72711e8"},{"name":"Delete custom field","id":"fc4d8278-25ad-4617-8e68-e4b74261b0e3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"DELETE","header":[{"key":"X-Spoki-Api-Key","value":"{{Api-Key}}","type":"text"}],"url":"{{Base-URL}}/api/1/custom-fields/{{id}}/","description":"

Rate Limit: 5/min

Possible Error Codes:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Status	Code	Title	Datail
403	spoki::3005		The custom field cannot be deleted because it is present in one or more automations
400	spoki::3004	The request body is not correct	No email specified

","urlObject":{"path":["api","1","custom-fields","{{id}}",""],"host":["{{Base-URL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"fc4d8278-25ad-4617-8e68-e4b74261b0e3"}],"id":"3084470a-cf61-482f-8181-d9522e08b231","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"id":"61f933db-947d-4cec-acbf-bbc6d57f7020","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"29025adc-ae9b-42ca-8b83-38b22e0c762b","type":"text/javascript","exec":[""]}}],"_postman_id":"3084470a-cf61-482f-8181-d9522e08b231","description":""},{"name":"Embedding via iframe","item":[{"name":"Auth User","id":"74937f1b-08a2-4552-92a7-9e917b58b691","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"X-Spoki-Api-Key","value":"{{Api-Key}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"email\": \"john.doe@domain.com\",\n \"private_key\": \"{{Private-Key}}\"\n}","options":{"raw":{"language":"json"}}},"url":"{{Base-URL}}/api/1/auth/get_authentication_token/","description":"

Possible Error Codes:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Status	Code	Title	Datail
400	spoki::3004	Invalid request body	Invalid data type in body
400	spoki::3004	Invalid request body	No email specified
400	spoki::3004	Invalid request body	No private_key specified
403	spoki::403	Access denied	Access not authorizied

","urlObject":{"path":["api","1","auth","get_authentication_token",""],"host":["{{Base-URL}}"],"query":[],"variable":[]}},"response":[{"id":"2d03bc15-aabc-4c69-a7cf-37df9065dad1","name":"200 OK","originalRequest":{"method":"POST","header":[{"warning":"This is a duplicate header and will be overridden by the X-Spoki-Api-Key header generated by Postman.","key":"X-Spoki-Api-Key","value":"{{Api-Key}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"email\": \"john.doe@domain.com\",\n \"private_key\": \"{{Private-Key}}\"\n}","options":{"raw":{"language":"json"}}},"url":"{{Base-URL}}/api/1/auth/get_authentication_token/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.14.0 (Ubuntu)"},{"key":"Date","value":"Mon, 06 Feb 2023 11:32:10 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"64"},{"key":"Connection","value":"keep-alive"},{"key":"Allow","value":"POST, OPTIONS"},{"key":"Vary","value":"Origin, Cookie"},{"key":"X-Frame-Options","value":"DENY"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Strict-Transport-Security","value":"max-age=31536000"}],"cookie":[],"responseTime":null,"body":"{\n \"token\": \"bj94hm-dx611474610f0046a2165b4964ea98g2\",\n \"uid\": \"NjK6\"\n}"}],"_postman_id":"74937f1b-08a2-4552-92a7-9e917b58b691"}],"id":"bb7ac7d0-3dfe-4365-a6e3-94d59acb3332","description":"

You can embed Spoki via iframe.

Check the complete guide

1. In your HTML page insert an empty div with id=\"spoki-embedding\"

2. Use the function below to init the iframe:

function initSpokiIframe () {\n    const headers = new Headers();\n    headers.append(\"Content-Type\", \"application/json\");\n    headers.append(\"X-Spoki-Api-Key\", \"{{Api-Key}}\");\n    const body = JSON.stringify({\n        email: \"john.doe@domain.com\",\n        private_key: \"{{Private-Key}}\",\n    });\n    const requestOptions = {\n        method: 'POST',\n        headers,\n        body,\n        redirect: 'follow'\n    };\n    fetch(\"https://spoki.app/api/1/auth/get_authentication_token/\", requestOptions)\n        .then(response => response.json())\n        .then(result => {\n            console.log(result);\n            const iframeParent = document.getElementById(\"spoki-embedding\");\n            const iframeEl = document.createElement(\"iframe\")\n            iframeEl.setAttribute(\"frameborder\", \"0\");\n            iframeEl.setAttribute(\"style\", \"position:fixed;bottom:10px;right:10px;height:600px;width:450px;border:2px solid #cccccc;border-radius: 8px;\");\n            iframeEl.setAttribute(\"src\", `https://spoki.app/chats?auth_token=${result.token}&auth_uid=${result.uid}`);\n            iframeParent.appendChild(iframeEl);\n        })\n        .catch(error => console.log('error', error));\n}\n\n

\n","_postman_id":"bb7ac7d0-3dfe-4365-a6e3-94d59acb3332","auth":{"type":"apikey","apikey":{"value":"{{Api-Key}}","key":""},"isInherited":true,"source":{"_postman_id":"b0f8e61f-7a2d-488c-8c5b-2835b092a3f9","id":"b0f8e61f-7a2d-488c-8c5b-2835b092a3f9","name":"Spoki API","type":"collection"}}},{"name":"Invitations","item":[{"name":"List, search, and filter invitations","id":"2e5ab420-3a11-48a2-96a1-99c0867d48a5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"X-Spoki-Api-Key","value":"{{Api-Key}}","type":"text"}],"url":"{{Base-URL}}/api/1/invitations/","description":"

Rate Limit: 5/min

\n","urlObject":{"path":["api","1","invitations",""],"host":["{{Base-URL}}"],"query":[{"disabled":true,"description":{"content":"

search by id, email, first_name, last_name

\n","type":"text/plain"},"key":"search","value":""}],"variable":[]}},"response":[{"id":"12ffc54b-6699-49eb-9918-de480f4f92b2","name":"200 OK","originalRequest":{"method":"GET","header":[],"url":"{{Base-URL}}/api/1/campaigns/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 28 Aug 2023 12:17:17 GMT"},{"key":"Server","value":"WSGIServer/0.2 CPython/3.7.9"},{"key":"Content-Type","value":"application/json"},{"key":"Vary","value":"Accept, Origin, Cookie"},{"key":"Allow","value":"GET, POST, HEAD, OPTIONS"},{"key":"Server-Timing","value":"TimerPanel_utime;dur=2801.1810000000423;desc=\"User CPU time\", TimerPanel_stime;dur=593.042999999966;desc=\"System CPU time\", TimerPanel_total;dur=3394.2240000000083;desc=\"Total CPU time\", TimerPanel_total_time;dur=3741.213321685791;desc=\"Elapsed time\", SQLPanel_sql_time;dur=106.60886764526367;desc=\"SQL 33 queries\", CachePanel_total_time;dur=16.034841537475586;desc=\"Cache 4 Calls\""},{"key":"Content-Length","value":"2930"},{"key":"X-Frame-Options","value":"DENY"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"}],"cookie":[],"responseTime":null,"body":"{\n \"count\": 1,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n {\n \"id\": 35122,\n \"name\": \"MyCampaign\",\n \"status\": \"Scheduled\",\n \"automation\": {\n \"id\": 253226,\n \"name\": \"Lorem Automation\"\n },\n \"lists\": [\n {\n \"id\": 4238,\n \"name\": \"MyList\",\n \"color\": null,\n \"created_datetime\": \"2023-05-24T12:51:42.763583+02:00\",\n \"contacts_count\": 0\n }\n ],\n \"scheduled_datetime\": \"2023-08-25T15:30:00.218000+02:00\",\n \"other_contacts\": [],\n \"contacts_count\": 0,\n \"automation_started\": 0,\n \"automation_completed\": 0,\n \"automation_failed\": 0,\n \"automation_valid_failed\": 0,\n \"automation_interacted_with\": 0,\n \"messages_sent\": 0,\n \"messages_received\": 0,\n \"messages_read\": 0,\n \"messages_failed\": 0,\n \"created_datetime\": \"2023-08-25T10:47:19.635070+02:00\"\n }\n ]\n}"}],"_postman_id":"2e5ab420-3a11-48a2-96a1-99c0867d48a5"},{"name":"Retrieve invitation","id":"3d72f6ee-785a-4185-9457-14946b9e974c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"X-Spoki-Api-Key","value":"{{Api-Key}}","type":"text"}],"url":"{{Base-URL}}/api/1/invitations/{{id}}/","description":"

Rate Limit: 5/min

\n","urlObject":{"path":["api","1","invitations","{{id}}",""],"host":["{{Base-URL}}"],"query":[],"variable":[]}},"response":[{"id":"3063f20e-f1d2-4693-87f8-e42df2e2f420","name":"200 OK","originalRequest":{"method":"GET","header":[{"key":"X-Spoki-Api-Key","value":"{{Api-Key}}","type":"text"}],"url":"{{Base-URL}}/api/1/campaigns/{{id}}/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.14.0 (Ubuntu)"},{"key":"Date","value":"Fri, 25 Aug 2023 08:24:08 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"604"},{"key":"Connection","value":"keep-alive"},{"key":"Allow","value":"GET, PUT, PATCH, DELETE, HEAD, OPTIONS"},{"key":"Vary","value":"Origin, Cookie"},{"key":"X-Frame-Options","value":"DENY"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Strict-Transport-Security","value":"max-age=31536000"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 12121223,\n \"name\": \"MyCampaign\",\n \"status\": 4,\n \"automation\": {\n \"id\": 11556237,\n \"name\": \"Lorem Automazione\"\n },\n \"lists\": [\n {\n \"id\": 4623451,\n \"name\": \"MyList\",\n \"color\": null,\n \"created_datetime\": \"2023-08-09T15:38:57.760934+02:00\",\n \"contacts_count\": 3\n }\n ],\n \"scheduled_datetime\": \"2023-08-09T16:20:00.308000+02:00\",\n \"other_contacts\": [],\n \"contacts_count\": 3,\n \"automation_started\": 0,\n \"automation_completed\": 3,\n \"automation_failed\": 0,\n \"automation_valid_failed\": 0,\n \"automation_interacted_with\": 2,\n \"messages_sent\": 0,\n \"messages_received\": 3,\n \"messages_read\": 0,\n \"messages_failed\": 0,\n \"created_datetime\": \"2023-08-09T16:18:13.394228+02:00\"\n}"}],"_postman_id":"3d72f6ee-785a-4185-9457-14946b9e974c"},{"name":"Invite new user by email","id":"3ac86644-33f3-45bf-920a-0d4064e2dbf8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"X-Spoki-Api-Key","value":"{{Api-Key}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"email\": \"john.doe@domain.com\",\n \"role\": \"Administrator\",\n \"additional_info\": {\n \"first_name\": \"John\",\n \"last_name\": \"Doe\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{Base-URL}}/api/1/invitations/","description":"

Rate Limit: 10/min

Allowed roles: Owner, Administrator, Chat Operator Manager, Chat Operator

Possible Error Codes:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Status	Code	Title	Datail
400	spoki::3004	Invalid request body	Invalid or no role specified
400	spoki::3004	Invalid request body	No email specified
400	spoki::3004	Invalid request body	No private_key specified
400	spoki::3007	Invalid request header	Invalid or no account specified
400	spoki::3007	Invalid request header	Invitation already exists

","urlObject":{"path":["api","1","invitations",""],"host":["{{Base-URL}}"],"query":[],"variable":[]}},"response":[{"id":"cf263076-b822-4a99-a802-8d59dd6ea4ee","name":"201 Created","originalRequest":{"method":"POST","header":[{"key":"X-Spoki-Api-Key","value":"{{Api-Key}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"name\": \"MyCampaign\",\n \"scheduled_datetime\": \"2024-08-28T10:00:00.000Z\",\n \"status\": \"Scheduled\",\n \"automation\": {{id}},\n \"lists\": [{{id}}]\n}","options":{"raw":{"language":"json"}}},"url":"{{Base-URL}}/api/1/campaigns/"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 28 Aug 2023 12:25:37 GMT"},{"key":"Server","value":"WSGIServer/0.2 CPython/3.7.9"},{"key":"Content-Type","value":"application/json"},{"key":"Vary","value":"Accept, Origin, Cookie"},{"key":"Allow","value":"GET, POST, HEAD, OPTIONS"},{"key":"Server-Timing","value":"TimerPanel_utime;dur=1296.68700000002;desc=\"User CPU time\", TimerPanel_stime;dur=267.5800000000663;desc=\"System CPU time\", TimerPanel_total;dur=1564.2670000000862;desc=\"Total CPU time\", TimerPanel_total_time;dur=1593.4910774230957;desc=\"Elapsed time\", SQLPanel_sql_time;dur=29.886484146118164;desc=\"SQL 9 queries\", CachePanel_total_time;dur=4.533052444458008;desc=\"Cache 4 Calls\""},{"key":"Content-Length","value":"184"},{"key":"X-Frame-Options","value":"DENY"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 12121223,\n \"name\": \"MyCampaign\",\n \"status\": \"Scheduled\",\n \"automation\": 2524,\n \"lists\": [\n 48\n ],\n \"scheduled_datetime\": \"2024-08-28T10:00:00+02:00\",\n \"created_datetime\": \"2023-08-28T14:25:37.316419+02:00\"\n}"}],"_postman_id":"3ac86644-33f3-45bf-920a-0d4064e2dbf8"},{"name":"Resend invitation email","id":"008a39b2-5df2-40f1-a6bd-dca96a905ded","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"X-Spoki-Api-Key","value":"{{Api-Key}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{}","options":{"raw":{"language":"json"}}},"url":"{{Base-URL}}/api/1/invitations/{{id}}/send/","description":"

Rate Limit: 5/min

\n","urlObject":{"path":["api","1","invitations","{{id}}","send",""],"host":["{{Base-URL}}"],"query":[],"variable":[]}},"response":[{"id":"9253f3f0-6aaa-4fb3-9947-617ab22df8a8","name":"201 Created","originalRequest":{"method":"POST","header":[{"key":"X-Spoki-Api-Key","value":"{{Api-Key}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"name\": \"MyCampaign\",\n \"scheduled_datetime\": \"2024-08-28T10:00:00.000Z\",\n \"status\": \"Scheduled\",\n \"automation\": {{id}},\n \"lists\": [{{id}}]\n}","options":{"raw":{"language":"json"}}},"url":"{{Base-URL}}/api/1/campaigns/"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 28 Aug 2023 12:25:37 GMT"},{"key":"Server","value":"WSGIServer/0.2 CPython/3.7.9"},{"key":"Content-Type","value":"application/json"},{"key":"Vary","value":"Accept, Origin, Cookie"},{"key":"Allow","value":"GET, POST, HEAD, OPTIONS"},{"key":"Server-Timing","value":"TimerPanel_utime;dur=1296.68700000002;desc=\"User CPU time\", TimerPanel_stime;dur=267.5800000000663;desc=\"System CPU time\", TimerPanel_total;dur=1564.2670000000862;desc=\"Total CPU time\", TimerPanel_total_time;dur=1593.4910774230957;desc=\"Elapsed time\", SQLPanel_sql_time;dur=29.886484146118164;desc=\"SQL 9 queries\", CachePanel_total_time;dur=4.533052444458008;desc=\"Cache 4 Calls\""},{"key":"Content-Length","value":"184"},{"key":"X-Frame-Options","value":"DENY"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 12121223,\n \"name\": \"MyCampaign\",\n \"status\": \"Scheduled\",\n \"automation\": 2524,\n \"lists\": [\n 48\n ],\n \"scheduled_datetime\": \"2024-08-28T10:00:00+02:00\",\n \"created_datetime\": \"2023-08-28T14:25:37.316419+02:00\"\n}"}],"_postman_id":"008a39b2-5df2-40f1-a6bd-dca96a905ded"},{"name":"Update role","id":"80ec97c6-b61c-4436-be85-3b6ab39e0863","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"X-Spoki-Api-Key","value":"{{Api-Key}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"role\": \"Chat Operator Manager\"\n}","options":{"raw":{"language":"json"}}},"url":"{{Base-URL}}/api/1/invitations/{{id}}/update_role/","description":"

Rate Limit: 5/min

Allowed roles: Owner, Administrator, Chat Operator Manager, Chat Operator

Possible Error Codes:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Status	Code	Title	Datail
400	spoki::3004	Invalid request body	Invalid or no role specified

","urlObject":{"path":["api","1","invitations","{{id}}","update_role",""],"host":["{{Base-URL}}"],"query":[],"variable":[]}},"response":[{"id":"f348b0b8-1029-4841-bc91-76eaf3135495","name":"201 Created","originalRequest":{"method":"POST","header":[{"key":"X-Spoki-Api-Key","value":"{{Api-Key}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"name\": \"MyCampaign\",\n \"scheduled_datetime\": \"2024-08-28T10:00:00.000Z\",\n \"status\": \"Scheduled\",\n \"automation\": {{id}},\n \"lists\": [{{id}}]\n}","options":{"raw":{"language":"json"}}},"url":"{{Base-URL}}/api/1/campaigns/"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 28 Aug 2023 12:25:37 GMT"},{"key":"Server","value":"WSGIServer/0.2 CPython/3.7.9"},{"key":"Content-Type","value":"application/json"},{"key":"Vary","value":"Accept, Origin, Cookie"},{"key":"Allow","value":"GET, POST, HEAD, OPTIONS"},{"key":"Server-Timing","value":"TimerPanel_utime;dur=1296.68700000002;desc=\"User CPU time\", TimerPanel_stime;dur=267.5800000000663;desc=\"System CPU time\", TimerPanel_total;dur=1564.2670000000862;desc=\"Total CPU time\", TimerPanel_total_time;dur=1593.4910774230957;desc=\"Elapsed time\", SQLPanel_sql_time;dur=29.886484146118164;desc=\"SQL 9 queries\", CachePanel_total_time;dur=4.533052444458008;desc=\"Cache 4 Calls\""},{"key":"Content-Length","value":"184"},{"key":"X-Frame-Options","value":"DENY"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 12121223,\n \"name\": \"MyCampaign\",\n \"status\": \"Scheduled\",\n \"automation\": 2524,\n \"lists\": [\n 48\n ],\n \"scheduled_datetime\": \"2024-08-28T10:00:00+02:00\",\n \"created_datetime\": \"2023-08-28T14:25:37.316419+02:00\"\n}"}],"_postman_id":"80ec97c6-b61c-4436-be85-3b6ab39e0863"},{"name":"Delete invitation","id":"9b1f57df-fefe-4f71-aa9b-a2d66278101c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"DELETE","header":[{"key":"X-Spoki-Api-Key","value":"{{Api-Key}}","type":"text"}],"url":"{{Base-URL}}/api/1/invitations/{{id}}/","description":"

Rate Limit: 10/min

\n","urlObject":{"path":["api","1","invitations","{{id}}",""],"host":["{{Base-URL}}"],"query":[],"variable":[]}},"response":[{"id":"60b98702-f8d1-40cc-b807-feac2282d80b","name":"204 No Content","originalRequest":{"method":"DELETE","header":[{"key":"X-Spoki-Api-Key","value":"{{Api-Key}}","type":"text"}],"url":"{{Base-URL}}/api/1/campaigns/{{id}}/"},"status":"No Content","code":204,"_postman_previewlanguage":"plain","header":[{"key":"Date","value":"Mon, 28 Aug 2023 12:26:38 GMT"},{"key":"Server","value":"WSGIServer/0.2 CPython/3.7.9"},{"key":"Vary","value":"Accept, Origin, Cookie"},{"key":"Allow","value":"GET, PUT, PATCH, DELETE, HEAD, OPTIONS"},{"key":"Server-Timing","value":"TimerPanel_utime;dur=1070.9779999999682;desc=\"User CPU time\", TimerPanel_stime;dur=224.4150000000218;desc=\"System CPU time\", TimerPanel_total;dur=1295.39299999999;desc=\"Total CPU time\", TimerPanel_total_time;dur=1268.4416770935059;desc=\"Elapsed time\", SQLPanel_sql_time;dur=18.60809326171875;desc=\"SQL 6 queries\", CachePanel_total_time;dur=6.557226181030273;desc=\"Cache 4 Calls\""},{"key":"Content-Length","value":"0"},{"key":"X-Frame-Options","value":"DENY"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"}],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"9b1f57df-fefe-4f71-aa9b-a2d66278101c"}],"id":"191c78fa-be99-4c92-bba6-3778634f030f","_postman_id":"191c78fa-be99-4c92-bba6-3778634f030f","description":"","auth":{"type":"apikey","apikey":{"value":"{{Api-Key}}","key":""},"isInherited":true,"source":{"_postman_id":"b0f8e61f-7a2d-488c-8c5b-2835b092a3f9","id":"b0f8e61f-7a2d-488c-8c5b-2835b092a3f9","name":"Spoki API","type":"collection"}}},{"name":"Lists","item":[{"name":"List, search, and filter lists","id":"f8c62d36-0bdd-40df-8190-333a52882dd9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"X-Spoki-Api-Key","value":"{{Api-Key}}","type":"text"}],"url":"{{Base-URL}}/api/1/lists/","description":"

Rate Limit: 5/min

\n","urlObject":{"path":["api","1","lists",""],"host":["{{Base-URL}}"],"query":[{"disabled":true,"description":{"content":"

You can search by list name

\n","type":"text/plain"},"key":"search","value":""}],"variable":[]}},"response":[],"_postman_id":"f8c62d36-0bdd-40df-8190-333a52882dd9"},{"name":"Create list","id":"e5f244d0-f742-40ae-b052-c31f31c273ba","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"X-Spoki-Api-Key","value":"{{Api-Key}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Newsletter\"\n}","options":{"raw":{"language":"json"}}},"url":"{{Base-URL}}/api/1/lists/","description":"

Rate Limit: 10/min

\n","urlObject":{"path":["api","1","lists",""],"host":["{{Base-URL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"e5f244d0-f742-40ae-b052-c31f31c273ba"},{"name":"Retrieve list","id":"55433c8b-807b-4e6e-a78a-08762948913a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"X-Spoki-Api-Key","value":"{{Api-Key}}","type":"text"}],"url":"{{Base-URL}}/api/1/lists/{{id}}/","description":"

Rate Limit: 5/min

\n","urlObject":{"path":["api","1","lists","{{id}}",""],"host":["{{Base-URL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"55433c8b-807b-4e6e-a78a-08762948913a"},{"name":"Create or update contacts, then add to the list","id":"2a151261-20f7-4a5f-a3d2-e0922d440a67","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"X-Spoki-Api-Key","value":"{{Api-Key}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"contacts\": [\n {\n \"phone\": \"{{phone}}\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"email\": \"john.doe@domain.com\",\n \"language\": \"en\",\n \"custom_fields\": {\n \"ORDER_ID\": \"1234\"\n }\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{Base-URL}}/api/1/lists/{{id}}/sync_contacts/","description":"

Rate Limit: 1/min

Note:
Do not update the contact using this API before initiating an automation for it. The contact will be automatically updated when the 'Start automation' API is called.

Max contacts allowed: 500.

Possible Error Codes:

In case the body isn't correct:

{\n    \"field\": [\n        \"Error description.\"\n    ]\n}\n\n

In case the body is correct, other error code:

{\n    \"type\": \"https://app.spoki.it/errors/spoki::3004\",\n    \"title\": \"The request body is not correct\",\n    \"code\": \"spoki::3004\",\n    \"status\": 400,\n    \"datail\": \"Too many contacts. Max 500 allowed.\"\n}\n\n

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Status	Code	Title	Datail
400	spoki::3004	The request body is not correct	Too many contacts. Max 500 allowed.

","urlObject":{"path":["api","1","lists","{{id}}","sync_contacts",""],"host":["{{Base-URL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"2a151261-20f7-4a5f-a3d2-e0922d440a67"},{"name":"Remove all contacts","id":"2889ba08-a4b6-4a23-b99b-0d90a973f95e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"X-Spoki-Api-Key","value":"{{Api-Key}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{}","options":{"raw":{"language":"json"}}},"url":"{{Base-URL}}/api/1/lists/{{id}}/remove_all_contacts/","description":"

Rate Limit: 5/min

\n","urlObject":{"path":["api","1","lists","{{id}}","remove_all_contacts",""],"host":["{{Base-URL}}"],"query":[],"variable":[]}},"response":[{"id":"8777d8f0-6729-4cec-8fee-6e2bd7d72b15","name":"200 OK","originalRequest":{"method":"POST","header":[{"key":"X-Spoki-Api-Key","value":"{{Api-Key}}","type":"text"}],"body":{"mode":"raw","raw":"{}","options":{"raw":{"language":"json"}}},"url":"{{Base-URL}}/api/1/lists/{{id}}/remove_all_contacts/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.14.0 (Ubuntu)"},{"key":"Date","value":"Tue, 10 Oct 2023 15:32:08 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"2"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept, Origin, Cookie"},{"key":"Allow","value":"POST, OPTIONS"},{"key":"X-Frame-Options","value":"DENY"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Strict-Transport-Security","value":"max-age=31536000"}],"cookie":[],"responseTime":null,"body":"{}"}],"_postman_id":"2889ba08-a4b6-4a23-b99b-0d90a973f95e"},{"name":"Delete list","id":"85656655-5fff-4baa-8b83-949b0c64dce8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"DELETE","header":[{"key":"X-Spoki-Api-Key","value":"{{Api-Key}}","type":"text"}],"url":"{{Base-URL}}/api/1/lists/{{id}}/","description":"

Rate Limit: 5/min

\n","urlObject":{"path":["api","1","lists","{{id}}",""],"host":["{{Base-URL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"85656655-5fff-4baa-8b83-949b0c64dce8"},{"name":"Remove contacts","id":"90906014-1c60-4118-bc2c-0fb64d8af7f2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"X-Spoki-Api-Key","value":"{{Api-Key}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"contacts\": [\n \"john.doe@example.com\",\n \"mario.rossi@example.com\"\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{Base-URL}}/api/1/lists/{{id}}/remove_contacts/","description":"

Rate Limit: 5/min

\n","urlObject":{"path":["api","1","lists","{{id}}","remove_contacts",""],"host":["{{Base-URL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"90906014-1c60-4118-bc2c-0fb64d8af7f2"}],"id":"03b49212-b28b-43d1-a29a-1a02d10d86bc","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"id":"80e404ff-9b36-4af5-b381-528f2a11cc4b","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"8eee7611-fbc0-40e7-aa2c-5536c8e7064b","type":"text/javascript","exec":[""]}}],"_postman_id":"03b49212-b28b-43d1-a29a-1a02d10d86bc","description":""},{"name":"Messages","item":[{"name":"Send Template","id":"22eb28b9-2ae1-435a-9364-0f32cf88b51c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-Spoki-Api-Key","value":"{{Api-Key}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"type\": \"Template\",\n \"phone\": \"{{phone}}\",\n \"template\": {{id}},\n \"email\": \"john.doe@domain.com\",\n \"language\": \"IT\",\n \"custom_fields\": {\n \"APPOINTMENT_DURATION\": \"2 hours\",\n \"APPOINTMENT_TYPE\": \"Haircut\"\n },\n \"buttons\": [\n {\n \"order\": 0,\n \"payload\": \"your_unique_optional_payload_for_button_0_to_be_returned_in_the_webhook\"\n },\n {\n \"order\": 1,\n \"payload\": \"your_unique_optional_payload_for_button_1_to_be_returned_in_the_webhook\"\n }\n ],\n \"metadata\": {\n \"your_str_meta\": \"lorem ipsum\",\n \"your_int_meta\": 3,\n \"your_float_meta\": 42.5,\n \"your_bool_meta\": true\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{Base-URL}}/api/1/messages/send/","description":"

Sends a message using a pre-approved WhatsApp template.

channel_id (Optional Body Field) — EDITED

An optional channel_id can now be included in the request body to explicitly route the message through a specific channel.

Routing Behaviour

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

`channel_id`	Behaviour
Omitted	Server resolves the routing channel from the account's primary channel that is compatible with the message type. Compatibility: `Template`, `Buttons`, `List` → WhatsApp only; `Free` → WhatsApp, SMS, SMS 2-Ways. If the primary channel is not compatible, the server may fall back to the first compatible active channel (subject to ongoing refinement).
Supplied (valid)	Channel must be tenant-scoped, in the compatible set for the message type, and have `status == ACTIVE`. For `type=Template` an additional guard checks `template.waba == channel.client_id`; a mismatch returns `400`.
Supplied (invalid)	Cross-tenant or non-numeric → `404`. Wrong platform or non-active → `400`.

The resolved channel is persisted on Message.attributes[\"channel\"], enabling subsequent GET /messages/?channel_id=... queries to filter on it.

Example Request Body

{\n  \"type\": \"Template\",\n  \"channel_id\": 17,\n  \"phone_number\": \"+39...\",\n  \"template_id\": 3068\n}\n

Response

Returns the message dispatcher's response. Status code varies by message type:

200 — synchronous dispatch
201 — resource created
202 — accepted for async dispatch

Rate Limit: 60/min

Send a template with media header with a dynamic media url.

IMPORTANT: The dynamic media must be of the same type.

Rate Limit: 60/min

Send a template carousel with dynamic media urls.

IMPORTANT: The dynamic media must be of the same type.

Rate Limit: 60/min

Send a template carousel with dynamic media urls.

You can specify \"language\" for a media, in order to send different media based on contact language.

If the language is not set, it will be used for all the other languages.

IMPORTANT: The dynamic media must be of the same type.

Rate Limit: 120/min

Rate Limit: 60/min

Rate Limit: 240/min

Returns the paginated list of messages belonging to the authenticated account.

This endpoint was previously POST-only. GET now returns paginated message history. Without channel_id the full account message history is returned.

Query Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Required	Description
`channel_id`	No	Filter messages whose `attributes[\"channel\"]` matches the given channel ID. Resolved via `resolve_channel` — cross-tenant or non-numeric values return 404.
`page`	No	Page number for pagination (1-based).
`page_size`	No	Number of results per page.

channel_id Validation

When channel_id is provided:

Cross-tenant or non-numeric → 404 { \"code\": \"spoki::404\", \"detail\": \"Channel not found\" }

Example Requests

GET /api/1/messages/\n→ 200  full account message history\nGET /api/1/messages/?channel_id=17\n→ 200  { \"count\": 5493, \"results\": [ ... ] }\nGET /api/1/messages/?channel_id=7   (cross-tenant)\n→ 404  { \"code\": \"spoki::404\", \"detail\": \"Channel not found\" }\n\n

Response (200 OK)

{\n  \"count\": 5493,\n  \"next\": \"https://api.spoki.it/api/1/messages/?page=2\",\n  \"previous\": null,\n  \"results\": [\n    {\n      \"id\": 98001,\n      \"type\": \"Template\",\n      \"phone_number\": \"+391234567890\",\n      \"status\": \"delivered\",\n      \"attributes\": {\n        \"channel\": 17\n      },\n      \"created_at\": \"2025-05-10T08:30:00Z\"\n    }\n  ]\n}\n\n

Rate Limit: 5/min
Caching Policy: The report for the current period is updated once a day or manually from the Spoki platform dashboard and will be cached for 30 minutes.

Day, Month, Year

\n","type":"text/plain"},"key":"granularity","value":"Day"},{"disabled":true,"description":{"content":"

YYYY-MM-DD

\n","type":"text/plain"},"key":"start_date","value":""},{"disabled":true,"description":{"content":"

YYYY-MM-DD

\n","type":"text/plain"},"key":"end_date","value":""}],"variable":[]}},"response":[{"id":"13e59170-c63a-4881-939e-764d88aa4b25","name":"200 OK","originalRequest":{"method":"GET","header":[],"url":"{{Base-URL}}/api/1/reports/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.14.0 (Ubuntu)"},{"key":"Date","value":"Wed, 21 Jun 2023 13:11:07 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"4488"},{"key":"Connection","value":"keep-alive"},{"key":"Allow","value":"GET, HEAD, OPTIONS"},{"key":"Vary","value":"Origin, Cookie"},{"key":"X-Frame-Options","value":"DENY"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Strict-Transport-Security","value":"max-age=31536000"}],"cookie":[],"responseTime":null,"body":"{\n \"count\": 2,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n {\n \"account\": 1384211,\n \"period_start\": \"2023-06-01\",\n \"contacted_contacts\": 1101,\n \"template_message_count\": 2577,\n \"free_message_count\": 2583,\n \"incoming_message_count\": 3869,\n \"exchanged_messages\": 9029,\n \"sent_message_count\": 5160,\n \"delivered_message_count\": 5160,\n \"read_message_count\": 4031,\n \"conversation_count\": 2220\n },\n {\n \"account\": 1384211,\n \"period_start\": \"2023-05-01\",\n \"contacted_contacts\": 1390,\n \"template_message_count\": 4083,\n \"free_message_count\": 4744,\n \"incoming_message_count\": 6564,\n \"exchanged_messages\": 15391,\n \"sent_message_count\": 8827,\n \"delivered_message_count\": 8827,\n \"read_message_count\": 7028,\n \"conversation_count\": 2857\n }\n ]\n}"}],"_postman_id":"456d5374-c581-46e6-bb78-1fcb74b35099"}],"id":"10e5fcfd-e274-46e4-9582-d0e2d1a39b34","_postman_id":"10e5fcfd-e274-46e4-9582-d0e2d1a39b34","description":"","auth":{"type":"apikey","apikey":{"value":"{{Api-Key}}","key":""},"isInherited":true,"source":{"_postman_id":"b0f8e61f-7a2d-488c-8c5b-2835b092a3f9","id":"b0f8e61f-7a2d-488c-8c5b-2835b092a3f9","name":"Spoki API","type":"collection"}}},{"name":"Roles","item":[{"name":"List, search, and filter roles","id":"3f281e4c-3672-43ec-854b-aef81787b8b4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"X-Spoki-Api-Key","value":"{{Api-Key}}","type":"text"}],"url":"{{Base-URL}}/api/1/roles/","description":"

Rate Limit: 5/min

\n","urlObject":{"path":["api","1","roles",""],"host":["{{Base-URL}}"],"query":[{"disabled":true,"description":{"content":"

search by id, email, first_name, last_name

\n","type":"text/plain"},"key":"search","value":""}],"variable":[]}},"response":[{"id":"a565bdcc-e28f-492b-8797-b10f227fc791","name":"200 OK","originalRequest":{"method":"GET","header":[{"key":"X-Spoki-Api-Key","value":"{{Api-Key}}","type":"text"}],"url":{"raw":"{{Base-URL}}/api/1/roles/","host":["{{Base-URL}}"],"path":["api","1","roles",""],"query":[{"key":"search","value":"","description":"search by id, email, first_name, last_name","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.27.0"},{"key":"Date","value":"Fri, 18 Oct 2024 14:16:22 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"3485"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept, origin, Accept-Language, Cookie"},{"key":"Allow","value":"GET, HEAD, OPTIONS"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Language","value":"en"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"Strict-Transport-Security","value":"max-age=31536000"}],"cookie":[],"responseTime":null,"body":"{\n \"count\": 10,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n {\n \"id\": 89112,\n \"user\": {\n \"id\": 71054,\n \"email\": \"john.doe@mydomain.com\",\n \"uid\": \"cea1a1f181fc4629aec47890cdf3d0db\",\n \"firstname\": \"John\",\n \"surname\": \"Doe\",\n \"image\": \"\",\n \"is_service\": false\n },\n \"role\": \"Owner\",\n \"is_active\": true,\n \"created_datetime\": \"2024-01-09T16:46:21.679770+01:00\",\n \"updated_datetime\": \"2024-01-09T16:46:21.679820+01:00\"\n },\n {\n \"id\": 99136,\n \"user\": {\n \"id\": 71058,\n \"email\": \"mario.rossi@mydomain.com\",\n \"uid\": \"f18f7abe01f34eba8fa9077dae42aefc\",\n \"firstname\": \"Mario\",\n \"surname\": \"Rossi\",\n \"image\": \"\",\n \"is_service\": false\n },\n \"role\": \"Administrator\",\n \"is_active\": true,\n \"created_datetime\": \"2024-06-20T12:51:48.164447+02:00\",\n \"updated_datetime\": \"2024-06-20T12:51:48.164473+02:00\"\n }\n ]\n}"}],"_postman_id":"3f281e4c-3672-43ec-854b-aef81787b8b4"},{"name":"Retrieve role","id":"1ca449a6-7643-47bf-a17e-44bc23dce419","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"X-Spoki-Api-Key","value":"{{Api-Key}}","type":"text"}],"url":"{{Base-URL}}/api/1/roles/{{id}}/","description":"

Rate Limit: 5/min

\n","urlObject":{"path":["api","1","roles","{{id}}",""],"host":["{{Base-URL}}"],"query":[],"variable":[]}},"response":[{"id":"091749d4-6a9c-439b-be79-afe85239962f","name":"200 OK","originalRequest":{"method":"GET","header":[{"key":"X-Spoki-Api-Key","value":"{{Api-Key}}","type":"text"}],"url":"{{Base-URL}}/api/1/roles/{{id}}/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.27.0"},{"key":"Date","value":"Fri, 18 Oct 2024 14:18:45 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"365"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept, origin, Accept-Language, Cookie"},{"key":"Allow","value":"GET, DELETE, HEAD, OPTIONS"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Language","value":"en"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"Strict-Transport-Security","value":"max-age=31536000"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 89112,\n \"user\": {\n \"id\": 71054,\n \"email\": \"john.doe@mydomain.com\",\n \"uid\": \"cea1a1f181fc4629aec47890cdf3d0db\",\n \"firstname\": \"John\",\n \"surname\": \"Doe\",\n \"image\": \"\",\n \"is_service\": false\n },\n \"role\": \"Owner\",\n \"is_active\": true,\n \"created_datetime\": \"2024-04-12T17:48:53.463898+02:00\",\n \"updated_datetime\": \"2024-04-12T17:48:53.463924+02:00\"\n}"}],"_postman_id":"1ca449a6-7643-47bf-a17e-44bc23dce419"},{"name":"Add Service User","id":"d8130563-21e9-4160-8cd2-e5588003bed8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"X-Spoki-Api-Key","value":"{{Api-Key}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"role\": \"Administrator\",\n \"name\": \"John\"\n}","options":{"raw":{"language":"json"}}},"url":"{{Base-URL}}/api/1/roles/add_service_user/","description":"

Rate Limit: 10/min

Possible Error Codes:

In case the body is correct, other error code:

{\n    \"type\": \"https://app.spoki.it/errors/spoki::3004\",\n    \"title\": \"The request body is not correct\",\n    \"code\": \"spoki::3004\",\n    \"status\": 400,\n    \"datail\": \"Invalid or no role specified.\"\n}\n\n

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Status	Code	Title	Datail
400	spoki::3004	The request body is not correct	Invalid or no role specified
400	spoki::3004	The request body is not correct	name not specified
400	spoki::3004	The request body is not correct	specify a valid role

","urlObject":{"path":["api","1","roles","add_service_user",""],"host":["{{Base-URL}}"],"query":[],"variable":[]}},"response":[{"id":"bd2beb37-5d1b-4f82-b852-a3f65fabde0c","name":"201 Created","originalRequest":{"method":"POST","header":[{"key":"X-Spoki-Api-Key","value":"{{Api-Key}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"role\": \"Administrator\",\n \"name\": \"John\"\n}","options":{"raw":{"language":"json"}}},"url":"{{Base-URL}}/api/1/roles/add_service_user/"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.27.0"},{"key":"Date","value":"Fri, 18 Oct 2024 14:23:57 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"347"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept, origin, Accept-Language, Cookie"},{"key":"Allow","value":"POST, OPTIONS"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Language","value":"en"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"Strict-Transport-Security","value":"max-age=31536000"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 914453,\n \"user\": {\n \"id\": 445684,\n \"email\": \"f8d964d0-955f-4c0r-af17-be8258c94v94@serviceuser.spoki.it\",\n \"uid\": \"0969f2205b494ae884773253516376bb\",\n \"firstname\": \"John\",\n \"surname\": \"\",\n \"image\": \"\",\n \"is_service\": true\n },\n \"role\": \"Administrator\",\n \"is_active\": true,\n \"created_datetime\": \"2024-10-18T16:23:57.861650+02:00\",\n \"updated_datetime\": \"2024-10-18T16:23:57.861670+02:00\"\n}"}],"_postman_id":"d8130563-21e9-4160-8cd2-e5588003bed8"},{"name":"Generate Private Key","id":"ea7fb344-9e14-4ce1-bfb1-dc1f0fe49938","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"X-Spoki-Api-Key","value":"{{Api-Key}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{}","options":{"raw":{"language":"json"}}},"url":"{{Base-URL}}/api/1/roles/{{id}}/generate_private_key/","description":"

Rate Limit: 10/min

Generate Private Key of a Service User

\n","urlObject":{"path":["api","1","roles","{{id}}","generate_private_key",""],"host":["{{Base-URL}}"],"query":[],"variable":[]}},"response":[{"id":"cfe66aa2-6d09-4ecf-aa35-bec0b393f4d2","name":"200 OK","originalRequest":{"method":"POST","header":[{"key":"X-Spoki-Api-Key","value":"{{Api-Key}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{}","options":{"raw":{"language":"json"}}},"url":"{{Base-URL}}/api/1/roles/{{id}}/generate_private_key/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.27.0"},{"key":"Date","value":"Fri, 18 Oct 2024 14:22:59 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"66"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept, origin, Accept-Language, Cookie"},{"key":"Allow","value":"POST, OPTIONS"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Language","value":"en"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"Strict-Transport-Security","value":"max-age=31536000"}],"cookie":[],"responseTime":null,"body":"\"b5e0ce522de128e01d7c37d6aba8b5cac6f19c1c84e76872c469cdb1733v819d\""}],"_postman_id":"ea7fb344-9e14-4ce1-bfb1-dc1f0fe49938"},{"name":"Has Private Key","id":"89451f9a-0ac9-4a4d-9a5b-c6bf90d60bb1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"X-Spoki-Api-Key","value":"{{Api-Key}}","type":"text"}],"url":"{{Base-URL}}/api/1/roles/{{id}}/has_private_key/","description":"

Rate Limit: 10/min

\n","urlObject":{"path":["api","1","roles","{{id}}","has_private_key",""],"host":["{{Base-URL}}"],"query":[],"variable":[]}},"response":[{"id":"d044512f-098f-4ba2-bc8e-b18426ef9ba5","name":"200 OK","originalRequest":{"method":"GET","header":[{"key":"X-Spoki-Api-Key","value":"{{Api-Key}}","type":"text"}],"url":"{{Base-URL}}/api/1/roles/{{id}}/has_private_key/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.27.0"},{"key":"Date","value":"Fri, 18 Oct 2024 14:22:45 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"5"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept, origin, Accept-Language, Cookie"},{"key":"Allow","value":"GET, HEAD, OPTIONS"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Language","value":"en"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"Strict-Transport-Security","value":"max-age=31536000"}],"cookie":[],"responseTime":null,"body":"false"}],"_postman_id":"89451f9a-0ac9-4a4d-9a5b-c6bf90d60bb1"},{"name":"Update Role","id":"e04f5e38-3de5-489d-a2be-93b61258534b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"X-Spoki-Api-Key","value":"{{Api-Key}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"role\": \"Chat Operator\"\n}","options":{"raw":{"language":"json"}}},"url":"{{Base-URL}}/api/1/roles/{{id}}/update_role/","description":"

Rate Limit: 10/min

Possible Error Codes:

In case the body is correct, other error code:

{\n    \"type\": \"https://app.spoki.it/errors/spoki::3004\",\n    \"title\": \"The request body is not correct\",\n    \"code\": \"spoki::3004\",\n    \"status\": 400,\n    \"datail\": \"Invalid or no role specified.\"\n}\n\n

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Status	Code	Title	Datail
400	spoki::3004	The request body is not correct	Invalid or no role specified
403	spoki::403	Access denied	you cannot change the role of the sole admin of the account
400	spoki::3004	The request body is not correct	specify a valid role

","urlObject":{"path":["api","1","roles","{{id}}","update_role",""],"host":["{{Base-URL}}"],"query":[],"variable":[]}},"response":[{"id":"24ec43d7-26b5-45e8-8e21-8335f0314fa9","name":"204 No Content","originalRequest":{"method":"POST","header":[{"key":"X-Spoki-Api-Key","value":"{{Api-Key}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"role\": \"Chat Operator Manager\"\n}","options":{"raw":{"language":"json"}}},"url":"{{Base-URL}}/api/1/roles/{{id}}/update_role/"},"status":"No Content","code":204,"_postman_previewlanguage":"plain","header":[{"key":"Server","value":"nginx/1.27.0"},{"key":"Date","value":"Fri, 18 Oct 2024 14:23:30 GMT"},{"key":"Content-Length","value":"0"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept, origin, Accept-Language, Cookie"},{"key":"Allow","value":"POST, OPTIONS"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Language","value":"en"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"Strict-Transport-Security","value":"max-age=31536000"}],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"e04f5e38-3de5-489d-a2be-93b61258534b"},{"name":"Delete role","id":"118b15a2-7a40-4ec7-b43d-ef0b73060bbb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"DELETE","header":[{"key":"X-Spoki-Api-Key","value":"{{Api-Key}}","type":"text"}],"url":"{{Base-URL}}/api/1/roles/{{id}}/","description":"

Rate Limit: 5/min

Possible Error Codes:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Status	Code	Title	Datail
403	spoki::403	Access denied	you cannot delete the role of the sole admin of the account

","urlObject":{"path":["api","1","roles","{{id}}",""],"host":["{{Base-URL}}"],"query":[],"variable":[]}},"response":[{"id":"b3beb819-a9c6-4642-b98e-dc5be455aaa9","name":"204 No Content","originalRequest":{"method":"DELETE","header":[{"key":"X-Spoki-Api-Key","value":"{{Api-Key}}","type":"text"}],"url":"{{Base-URL}}/api/1/roles/{{id}}/"},"status":"No Content","code":204,"_postman_previewlanguage":"plain","header":[{"key":"Server","value":"nginx/1.27.0"},{"key":"Date","value":"Fri, 18 Oct 2024 14:25:14 GMT"},{"key":"Content-Length","value":"0"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept, origin, Accept-Language, Cookie"},{"key":"Allow","value":"GET, DELETE, HEAD, OPTIONS"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Language","value":"en"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"Strict-Transport-Security","value":"max-age=31536000"}],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"118b15a2-7a40-4ec7-b43d-ef0b73060bbb"}],"id":"ea4241bf-b974-4729-8f16-b4297005cd3f","_postman_id":"ea4241bf-b974-4729-8f16-b4297005cd3f","description":"","auth":{"type":"apikey","apikey":{"value":"{{Api-Key}}","key":""},"isInherited":true,"source":{"_postman_id":"b0f8e61f-7a2d-488c-8c5b-2835b092a3f9","id":"b0f8e61f-7a2d-488c-8c5b-2835b092a3f9","name":"Spoki API","type":"collection"}}},{"name":"Tags","item":[{"name":"List, search, and filter tags","id":"a0766e4c-3567-4369-8428-b39ce3710cff","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"X-Spoki-Api-Key","value":"{{Api-Key}}","type":"text"}],"url":"{{Base-URL}}/api/1/tags/","description":"

Rate Limit: 10/min

\n","urlObject":{"path":["api","1","tags",""],"host":["{{Base-URL}}"],"query":[{"disabled":true,"key":"","value":""}],"variable":[]}},"response":[{"id":"44b69777-d079-4e46-ab0e-6cc6da6a759d","name":"200 OK","originalRequest":{"method":"GET","header":[{"key":"X-Spoki-Api-Key","value":"{{Api-Key}}","type":"text"}],"url":{"raw":"{{Base-URL}}/api/1/tags/","host":["{{Base-URL}}"],"path":["api","1","tags",""],"query":[{"key":"","value":"","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.14.0 (Ubuntu)"},{"key":"Date","value":"Fri, 02 Feb 2024 10:38:32 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"282"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept, Origin, Cookie"},{"key":"Allow","value":"GET, POST, HEAD, OPTIONS"},{"key":"X-Frame-Options","value":"DENY"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Strict-Transport-Security","value":"max-age=31536000"}],"cookie":[],"responseTime":null,"body":"{\n \"count\": 4,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n {\n \"id\": 232321,\n \"name\": \"cold\",\n \"color\": \"#16d46d\",\n \"order\": 3\n },\n {\n \"id\": 232323,\n \"name\": \"blue-monday\",\n \"color\": \"#16d46d\",\n \"order\": 2\n },\n {\n \"id\": 232324,\n \"name\": \"hot\",\n \"color\": \"#16d46d\",\n \"order\": 1\n },\n {\n \"id\": 232325,\n \"name\": \"black-friday\",\n \"color\": \"#16d46d\",\n \"order\": 0\n }\n ]\n}"}],"_postman_id":"a0766e4c-3567-4369-8428-b39ce3710cff"},{"name":"Retrieve tag","id":"dc89e0d0-f563-493c-be54-7fe4bb8cc97b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"X-Spoki-Api-Key","value":"{{Api-Key}}","type":"text"}],"url":"{{Base-URL}}/api/1/tags/{{id}}/","description":"

Rate Limit: 10/min

\n","urlObject":{"path":["api","1","tags","{{id}}",""],"host":["{{Base-URL}}"],"query":[],"variable":[]}},"response":[{"id":"9d9ad919-b5fd-4fed-ab18-e820358001ce","name":"200 OK","originalRequest":{"method":"GET","header":[{"key":"X-Spoki-Api-Key","value":"{{Api-Key}}","type":"text"}],"url":"{{Base-URL}}/api/1/tags/{{id}}/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.14.0 (Ubuntu)"},{"key":"Date","value":"Fri, 02 Feb 2024 10:40:31 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"59"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept, Origin, Cookie"},{"key":"Allow","value":"GET, PUT, PATCH, DELETE, HEAD, OPTIONS"},{"key":"X-Frame-Options","value":"DENY"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Strict-Transport-Security","value":"max-age=31536000"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 232323,\n \"name\": \"blue-monday\",\n \"color\": \"#16d46d\",\n \"order\": 2\n}"}],"_postman_id":"dc89e0d0-f563-493c-be54-7fe4bb8cc97b"}],"id":"dc6bae68-8104-4375-a581-b46f15478705","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"id":"80e404ff-9b36-4af5-b381-528f2a11cc4b","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"8eee7611-fbc0-40e7-aa2c-5536c8e7064b","type":"text/javascript","exec":[""]}}],"_postman_id":"dc6bae68-8104-4375-a581-b46f15478705","description":""},{"name":"Templates","item":[{"name":"List, search, and filter templates","id":"1a205d63-9a95-40d0-944c-050591db7a4b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"X-Spoki-Api-Key","value":"{{Api-Key}}","type":"text"}],"url":"{{Base-URL}}/api/1/templates/","description":"

Returns the paginated list of templates belonging to the authenticated account.

Templates are matched by Template.waba == channel.client_id. Without channel_id the full account template set is returned. With channel_id, only templates whose waba matches that channel's client_id are returned.

Query Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`channel_id`	number	No	Filter templates to those whose `waba` matches the given channel's `client_id`. The channel is validated before filtering — see error responses below.

channel_id Validation

When channel_id is provided, the following checks are applied in order:

Non-numeric or cross-tenant → 404 { \"code\": \"spoki::404\", \"detail\": \"Channel not found\" }
Not a WhatsApp channel → 400 { \"detail\": \"Channel must be a WhatsApp channel\" }
Not ACTIVE (status ≠ Active) → 400 { \"detail\": \"Channel must be active\" }

Example Requests

GET /api/1/templates/\n→ 200  full account template set\n\nGET /api/1/templates/?channel_id=17\n→ 200  { \"count\": 12, \"results\": [ ... ] }\n\nGET /api/1/templates/?channel_id=7   (cross-tenant)\n→ 404  { \"code\": \"spoki::404\", \"detail\": \"Channel not found\" }\n

Multi-WABA Caller Pattern

For callers managing multiple WABAs, use the following two-request pattern:

GET /channel/?whatsapp_business_account=<waba_id> → pick the row whose status == 3 (Active)
GET /templates/?channel_id=<picked.id>

Response (200 OK)

{\n  \"count\": 12,\n  \"next\": null,\n  \"previous\": null,\n  \"results\": [\n    {\n      \"id\": 101,\n      \"name\": \"promo_spring\",\n      \"language\": \"it\",\n      \"category\": \"MARKETING\",\n      \"status\": \"APPROVED\",\n      \"waba\": \"123456789\",\n      \"components\": [\n        { \"type\": \"BODY\", \"text\": \"Scopri le nostre offerte primaverili!\" }\n      ]\n    }\n  ]\n}\n

\n","urlObject":{"path":["api","1","templates",""],"host":["{{Base-URL}}"],"query":[{"disabled":true,"description":{"content":"

You can search by: 'id', 'name', 'text'

\n","type":"text/plain"},"key":"search","value":null}],"variable":[]}},"response":[{"id":"b0a6f639-38f7-48d0-8273-c744217752ac","name":"200 OK","originalRequest":{"method":"GET","header":[{"key":"X-Spoki-Api-Key","value":"{{Api-Key}}","type":"text"}],"url":"{{Base-URL}}/api/1/templates/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.14.0 (Ubuntu)"},{"key":"Date","value":"Thu, 01 Jun 2023 13:24:45 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"14369"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept, Origin, Cookie"},{"key":"Allow","value":"GET, HEAD, OPTIONS"},{"key":"X-Frame-Options","value":"DENY"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Strict-Transport-Security","value":"max-age=31536000"}],"cookie":[],"responseTime":null,"body":"{\n \"count\": 3,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n {\n \"id\": 260,\n \"name\": \"promo_costumi\",\n \"category\": \"ACCOUNT_UPDATE\",\n \"is_approved\": true,\n \"is_favorite\": false,\n \"customfield_set\": [],\n \"templatelocalization_set\": [\n {\n \"language\": \"it\",\n \"status\": \"APPROVED\",\n \"rejection_reason\": null,\n \"header\": null,\n \"body\": {\n \"component_type\": \"body\",\n \"format\": \"text\",\n \"text\": \"Ciao, abbiamo una bellissima notizia per te! 😍\\n\\nDa oggi *fino a fine mese* avrai la possibilità di acquistare *i tuoi costumi preferiti* a *metà prezzo* 🛍!\\n\\nSfoglia il catalogo e scegli il tuo modello preferito 👇\"\n },\n \"footer\": null,\n \"button_set\": [\n {\n \"order\": 0,\n \"button_type\": \"quick_reply\",\n \"text\": \"Guarda il Catalogo\",\n \"phone_number\": null,\n \"url\": null\n }\n ],\n \"default_header_media\": null\n }\n ]\n },\n {\n \"id\": 189,\n \"name\": \"Custom Message\",\n \"category\": \"ACCOUNT_UPDATE\",\n \"is_approved\": true,\n \"is_favorite\": true,\n \"customfield_set\": [\n \"%%SENTENCE%%\"\n ],\n \"templatelocalization_set\": [\n {\n \"language\": \"it\",\n \"status\": \"APPROVED\",\n \"rejection_reason\": null,\n \"header\": null,\n \"body\": {\n \"component_type\": \"body\",\n \"format\": \"text\",\n \"text\": \"Ciao! %%SENTENCE%%\"\n },\n \"footer\": null,\n \"button_set\": [],\n \"default_header_media\": null\n }\n ]\n },\n {\n \"id\": 249,\n \"name\": \"ordine_tracking_official_sf\",\n \"category\": \"ACCOUNT_UPDATE\",\n \"is_approved\": true,\n \"is_favorite\": false,\n \"customfield_set\": [\n \"%%FIRST_NAME%%\",\n \"%%FLEX_LINK%%\",\n \"%%WOO_TRACKING_INFO%%\",\n \"%%WOO_ORDER_ID%%\",\n \"%%FLEX_ACCOUNT_NAME%%\"\n ],\n \"templatelocalization_set\": [\n {\n \"language\": \"en\",\n \"status\": \"APPROVED\",\n \"rejection_reason\": null,\n \"header\": null,\n \"body\": {\n \"component_type\": \"body\",\n \"format\": \"text\",\n \"text\": \"👋 Hi %%FIRST_NAME%%, we have some news about your order n° %%WOO_ORDER_ID%% 🛍 for the store %%FLEX_ACCOUNT_NAME%%! Here the shipping info: %%WOO_TRACKING_INFO%%👍 Do you need support? ➡️➡️➡️ %%FLEX_LINK%% _do_ _not_ _reply_ _to_ _this_ _message_\"\n },\n \"footer\": null,\n \"button_set\": [],\n \"default_header_media\": null\n },\n {\n \"language\": \"es\",\n \"status\": \"PENDING\",\n \"rejection_reason\": null,\n \"header\": null,\n \"body\": {\n \"component_type\": \"body\",\n \"format\": \"text\",\n \"text\": \"👋 Hola %%FIRST_NAME%%, tu número de pedido %%WOO_ORDER_ID%% 🛍 de la tienda %%FLEX_ACCOUNT_NAME%% ha sido enviado 🚀 Aquí está la información de envío: %%WOO_TRACKING_INFO%%. 👍 ¿Necesitas ayuda? ➡️➡️➡️ %%FLEX_LINK%% _no_ _contestes_ _a_ _este_ _mensaje_\"\n },\n \"footer\": null,\n \"button_set\": [],\n \"default_header_media\": null\n },\n {\n \"language\": \"pt_PT\",\n \"status\": \"PENDING\",\n \"rejection_reason\": null,\n \"header\": null,\n \"body\": {\n \"component_type\": \"body\",\n \"format\": \"text\",\n \"text\": \"👋 Olá %%FIRST_NAME%%, temos notícias sobre o rastreamento de seu pedido nº %%WOO_ORDER_ID%% 🛍 da loja %%FLEX_ACCOUNT_NAME%% 🚀 Aqui estão as informações de envio: %%WOO_TRACKING_INFO%%. Precisa de ajuda? ➡️➡️➡️ %%FLEX_LINK%% _ não_ _ responda _ _ a _ _ essa _ _ mensagem_\"\n },\n \"footer\": null,\n \"button_set\": [],\n \"default_header_media\": null\n },\n {\n \"language\": \"fr\",\n \"status\": \"APPROVED\",\n \"rejection_reason\": null,\n \"header\": null,\n \"body\": {\n \"component_type\": \"body\",\n \"format\": \"text\",\n \"text\": \"👋 Salut {{1}} il y a des nouvelles des données de poursuite de votre commande n°{{2}} 🛍 de votre compte {{3}} 🚀 Voici les informations: {{4}}. Vous avez besoin d’aide? ➡️➡️➡️ {{5}} _ne_ pas _ _ répondre_\"\n },\n \"footer\": null,\n \"button_set\": [],\n \"default_header_media\": null\n }\n ]\n }\n ]\n}"}],"_postman_id":"1a205d63-9a95-40d0-944c-050591db7a4b"},{"name":"Create template","id":"32a93c88-68c0-41bf-9efa-77a4c225305f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"X-Spoki-Api-Key","value":"{{Api-Key}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"name\": \"black_friday_example\",\n \"category\": \"MARKETING\",\n \"subcategory\": \"CLASSIC\",\n \"templatelocalization_set\": [\n {\n \"language\": \"en\",\n \"status\": 0,\n \"header_template_component\": {\n \"component_type\": \"header\",\n \"parameters\": [],\n \"format\": \"text\",\n \"text\": \"Black Friday Special Offer!\"\n },\n \"body_template_component\": {\n \"component_type\": \"body\",\n \"parameters\": [],\n \"format\": null,\n \"text\": \"Hi %%FIRST_NAME%%!\\n*Don't miss out* on our exclusive Black Friday promotion!\\n\\nGet your favorite white t-shirt at a fantastic *50% off*!\\n\\nThis is a limited-time offer, so make sure to grab yours before it's gone.\\n\\n*Shop now* and elevate your wardrobe with this essential piece!\"\n },\n \"footer_template_component\": {\n \"component_type\": \"footer\",\n \"parameters\": [],\n \"format\": null,\n \"text\": \"MyCompany\"\n },\n \"templatebuttoncomponent_set\": [\n {\n \"component_type\": null,\n \"text\": \"Shop Now\",\n \"order\": 0,\n \"button_type\": \"url\",\n \"phone_number\": null,\n \"form_id\": null,\n \"url\": \"https://myshop.com/my-product?coupon=MYCOUPON\",\n \"send_as_shortlink\": true\n },\n {\n \"component_type\": null,\n \"text\": \"Unsubscribe\",\n \"order\": 1,\n \"button_type\": \"unsubscribe\",\n \"phone_number\": null,\n \"form_id\": null,\n \"url\": null,\n \"send_as_shortlink\": null\n }\n ],\n \"example_custom_fields\": {\n \"FIRST_NAME\": \"John\"\n },\n \"example_header_media\": null,\n \"default_header_media\": null,\n \"templatecarouselcomponent_set\": null\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{Base-URL}}/api/1/templates/","description":"

Creates a new template for the authenticated account.

When channel_id is provided in the request body, the created template's waba is automatically set to that channel's client_id. Without channel_id, the template is created under the account's default WABA.

Request Body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`channel_id`	number	No	The ID of the channel whose `client_id` will be used as the template's `waba`. The channel must be a WhatsApp channel and must be ACTIVE.
`name`	string	Yes	The name of the template (snake_case, e.g. `promo_spring`).
`language`	string	Yes	The language code for the template (e.g. `it`, `en`).
`category`	string	Yes	The template category. One of: `MARKETING`, `UTILITY`, `AUTHENTICATION`.
`components`	array	Yes	Array of component objects defining the template structure (e.g. HEADER, BODY, FOOTER, BUTTONS).

channel_id Validation

When channel_id is provided, the following checks are applied in order:

Non-numeric or cross-tenant → 404 { \"code\": \"spoki::404\", \"detail\": \"Channel not found\" }
Not a WhatsApp channel → 400 { \"detail\": \"Channel must be a WhatsApp channel\" }
Not ACTIVE (status ≠ Active) → 400 { \"detail\": \"Channel must be active\" }

Example Request Body

{\n  \"channel_id\": 17,\n  \"name\": \"promo_spring\",\n  \"language\": \"it\",\n  \"category\": \"MARKETING\",\n  \"components\": [\n    { \"type\": \"BODY\", \"text\": \"Scopri le nostre offerte primaverili!\" }\n  ]\n}\n

Multi-WABA Caller Pattern

For callers managing multiple WABAs, use the following two-request pattern:

GET /channel/?whatsapp_business_account=<waba_id> → pick the row whose status == 3 (Active)
POST /templates/ with channel_id=<picked.id> in the body

Response (201 Created)

{\n  \"id\": 101,\n  \"name\": \"promo_spring\",\n  \"language\": \"it\",\n  \"category\": \"MARKETING\",\n  \"status\": \"PENDING\",\n  \"waba\": \"123456789\",\n  \"components\": [\n    { \"type\": \"BODY\", \"text\": \"Scopri le nostre offerte primaverili!\" }\n  ]\n}\n

\n","urlObject":{"path":["api","1","templates",""],"host":["{{Base-URL}}"],"query":[],"variable":[]}},"response":[{"id":"e9b7d386-57a1-485a-8420-e7f88343cefd","name":"201 Created","originalRequest":{"method":"POST","header":[{"key":"X-Spoki-Api-Key","value":"{{Api-Key}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"name\": \"black_friday_example\",\n \"category\": \"MARKETING\",\n \"subcategory\": \"CLASSIC\",\n \"templatelocalization_set\": [\n {\n \"language\": \"en\",\n \"status\": 0,\n \"header_template_component\": {\n \"component_type\": \"header\",\n \"parameters\": [],\n \"format\": \"text\",\n \"text\": \"Black Friday Special Offer!\"\n },\n \"body_template_component\": {\n \"component_type\": \"body\",\n \"parameters\": [],\n \"format\": null,\n \"text\": \"Hi %%FIRST_NAME%%!\\n*Don't miss out* on our exclusive Black Friday promotion!\\n\\nGet your favorite white t-shirt at a fantastic *50% off*!\\n\\nThis is a limited-time offer, so make sure to grab yours before it's gone.\\n\\n*Shop now* and elevate your wardrobe with this essential piece!\"\n },\n \"footer_template_component\": {\n \"component_type\": \"footer\",\n \"parameters\": [],\n \"format\": null,\n \"text\": \"MyCompany\"\n },\n \"templatebuttoncomponent_set\": [\n {\n \"component_type\": null,\n \"text\": \"Shop Now\",\n \"order\": 0,\n \"button_type\": \"url\",\n \"phone_number\": null,\n \"form_id\": null,\n \"url\": \"https://myshop.com/my-product?coupon=MYCOUPON\",\n \"send_as_shortlink\": true\n },\n {\n \"component_type\": null,\n \"text\": \"Unsubscribe\",\n \"order\": 1,\n \"button_type\": \"unsubscribe\",\n \"phone_number\": null,\n \"form_id\": null,\n \"url\": null,\n \"send_as_shortlink\": null\n }\n ],\n \"example_custom_fields\": {\n \"FIRST_NAME\": \"John\"\n },\n \"example_header_media\": null,\n \"default_header_media\": null,\n \"templatecarouselcomponent_set\": null\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{Base-URL}}/api/1/templates/"},"status":"Created","code":201,"_postman_previewlanguage":null,"header":[{"key":"Server","value":"nginx/1.29.3"},{"key":"Date","value":"Mon, 10 Nov 2025 11:20:58 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"1304"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept, origin, Accept-Language, Cookie"},{"key":"Allow","value":"GET, POST, HEAD, OPTIONS"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Language","value":"en"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"Strict-Transport-Security","value":"max-age=31536000"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 123456789,\n \"name\": \"black_friday_example\",\n \"category\": \"MARKETING\",\n \"subcategory\": \"CLASSIC\",\n \"is_approved\": false,\n \"is_favorite\": false,\n \"customfield_set\": [\n \"%%FIRST_NAME%%\"\n ],\n \"templatelocalization_set\": [\n {\n \"id\": 12121212,\n \"language\": \"en\",\n \"status\": \"DRAFT\",\n \"rejection_reason\": null,\n \"default_header_media\": null,\n \"header_template_component\": {\n \"component_type\": \"header\",\n \"format\": \"text\",\n \"text\": \"Black Friday Special Offer!\"\n },\n \"body_template_component\": {\n \"component_type\": \"body\",\n \"format\": null,\n \"text\": \"Hi %%FIRST_NAME%%!\\n*Don't miss out* on our exclusive Black Friday promotion!\\n\\nGet your favorite white t-shirt at a fantastic *50% off*!\\n\\nThis is a limited-time offer, so make sure to grab yours before it's gone.\\n\\n*Shop now* and elevate your wardrobe with this essential piece!\"\n },\n \"footer_template_component\": {\n \"component_type\": \"footer\",\n \"format\": null,\n \"text\": \"MyCompany\"\n },\n \"templatebuttoncomponent_set\": [\n {\n \"order\": 0,\n \"button_type\": \"url\",\n \"text\": \"Shop Now\",\n \"phone_number\": null,\n \"url\": \"https://myshop.com/my-product?coupon=MYCOUPON\",\n \"form_id\": null,\n \"send_as_shortlink\": true,\n \"shortlink_code\": \"k6OvHQjOb4i1\"\n },\n {\n \"order\": 1,\n \"button_type\": \"unsubscribe\",\n \"text\": \"Unsubscribe\",\n \"phone_number\": null,\n \"url\": null,\n \"form_id\": null,\n \"send_as_shortlink\": false,\n \"shortlink_code\": null\n }\n ],\n \"templatecarouselcomponent_set\": []\n }\n ],\n \"template_groups\": []\n}"}],"_postman_id":"32a93c88-68c0-41bf-9efa-77a4c225305f"},{"name":"Clone template","id":"51c7104a-6629-4da8-94ab-0332fae34590","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"X-Spoki-Api-Key","value":"{{Api-Key}}","type":"text"}],"url":"{{Base-URL}}/api/1/templates/{{id}}/clone/","description":"

Rate Limit: 10/min

Overview

Create a duplicate copy of an existing template. The clone is independent and starts in DRAFT status, allowing you to modify it without affecting the original.

What Gets Cloned

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Element	Cloned?	Notes
✅ Template name	Yes	Appended with _1, _2, etc.
✅ Category	Yes	Exact copy
✅ Subcategory	Yes	Exact copy
✅ All localizations	Yes	All languages copied
✅ Components	Yes	Header, body, footer
✅ Buttons	Yes	All button configurations
✅ Carousel cards	Yes	All cards if carousel template
✅ Custom fields	Yes	All variables preserved
✅ Media references	Yes	Same media IDs
❌ Template ID	No	New ID assigned
❌ Approval status	No	Starts as DRAFT
❌ Provider ID	No	Starts as null
❌ Template groups	No	Not copied
❌ Favorite status	No	Defaults to false

What's Different

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Original Template	Cloned Template
id: 12345	id: 67890 (new)
name: \"order_confirmation\"	name: \"order_confirmation_1\"
is_approved: true	is_approved: false
status: APPROVED	status: DRAFT
template_groups: [1, 5]	template_groups: []
is_favorite: true	is_favorite: false

When to Use Clone

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Scenario	Use Clone?	Why
Create template variation	✅ Yes	Safe A/B testing
Update production template	✅ Yes	Maintain uptime
Test content changes	✅ Yes	Original stays live
Multi-language rollout	✅ Yes	Test per language
Seasonal versions	✅ Yes	Holiday vs regular
Fix rejected template	❌ No	Use back_to_draft
Quick typo fix	⚠️ Maybe	Consider back_to_draft

Clone vs Back to Draft

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Aspect	Clone	Back to Draft
Original template	Unchanged	Reverted to DRAFT
New template	Created	None
Original availability	✅ Stays active	❌ Becomes unavailable
Downtime	❌ None	✅ 1-3 days
Use case	Production updates	Quick fixes
Template ID	New ID	Same ID

Comparison Table

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Operation	Clone	Back to Draft	PATCH
Creates new template	✅ Yes	❌ No	❌ No
Preserves original	✅ Yes	❌ No	✅ Yes
Causes downtime	❌ No	✅ Yes	Depends
New ID	✅ Yes	❌ No	❌ No
Requires approval	✅ Yes	✅ Yes (if content changed)	Depends
Best for production	✅ Yes	⚠️ Risky	⚠️ Depends

\n","urlObject":{"path":["api","1","templates","{{id}}","clone",""],"host":["{{Base-URL}}"],"query":[],"variable":[]}},"response":[{"id":"2a12702b-cb2f-4665-b092-b3a58c5c9eaa","name":"201 Created","originalRequest":{"method":"GET","header":[{"key":"X-Spoki-Api-Key","value":"{{Api-Key}}","type":"text"}],"url":"{{Base-URL}}/api/1/templates/{{id}}/clone/"},"status":"Created","code":201,"_postman_previewlanguage":null,"header":[{"key":"Server","value":"nginx/1.29.3"},{"key":"Date","value":"Mon, 10 Nov 2025 11:58:30 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"1306"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept, origin, Accept-Language, Cookie"},{"key":"Allow","value":"GET, HEAD, OPTIONS"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Language","value":"en"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"Strict-Transport-Security","value":"max-age=31536000"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 123456789,\n \"name\": \"black_friday_example_1\",\n \"category\": \"MARKETING\",\n \"subcategory\": \"CLASSIC\",\n \"integration\": -1,\n \"is_approved\": false,\n \"is_favorite\": false,\n \"customfield_set\": [\n \"%%FIRST_NAME%%\"\n ],\n \"templatelocalization_set\": [\n {\n \"id\": 121212,\n \"language\": \"en\",\n \"status\": \"DRAFT\",\n \"rejection_reason\": null,\n \"default_header_media\": null,\n \"header_template_component\": {\n \"component_type\": \"header\",\n \"format\": \"text\",\n \"text\": \"Black Friday Special Offer!\"\n },\n \"body_template_component\": {\n \"component_type\": \"body\",\n \"format\": null,\n \"text\": \"Hi %%FIRST_NAME%%!\\n*Don't miss out* on our exclusive Black Friday promotion!\\n\\nGet your favorite white t-shirt at a fantastic *50% off*!\\n\\nThis is a limited-time offer, so make sure to grab yours before it's gone.\\n\\n*Shop now* and elevate your wardrobe with this essential piece.\"\n },\n \"footer_template_component\": {\n \"component_type\": \"footer\",\n \"format\": null,\n \"text\": \"MyCompany\"\n },\n \"templatebuttoncomponent_set\": [\n {\n \"order\": 0,\n \"button_type\": \"url\",\n \"text\": \"Shop Now\",\n \"phone_number\": null,\n \"url\": \"https://myshop.com/my-product?coupon=MYCOUPON\",\n \"form_id\": null,\n \"send_as_shortlink\": true,\n \"shortlink_code\": \"k6OvHQjOb4i1\"\n },\n {\n \"order\": 1,\n \"button_type\": \"unsubscribe\",\n \"text\": \"Unsubscribe\",\n \"phone_number\": null,\n \"url\": null,\n \"form_id\": null,\n \"send_as_shortlink\": false,\n \"shortlink_code\": null\n }\n ],\n \"templatecarouselcomponent_set\": []\n }\n ],\n \"template_groups\": []\n}"}],"_postman_id":"51c7104a-6629-4da8-94ab-0332fae34590"},{"name":"Update template","id":"e8653467-6e21-4054-a1a4-74a01da1ca63","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"PATCH","header":[{"key":"X-Spoki-Api-Key","value":"{{Api-Key}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"name\": \"black_friday_example\",\n \"category\": \"MARKETING\",\n \"subcategory\": \"CLASSIC\",\n \"template_groups\": [],\n \"templatelocalization_set\": [\n {\n \"id\": 12121212,\n \"language\": \"en\",\n \"status\": 0,\n \"header_template_component\": {\n \"component_type\": \"header\",\n \"parameters\": [],\n \"format\": \"text\",\n \"text\": \"Black Friday Special Offer!\"\n },\n \"body_template_component\": {\n \"component_type\": \"body\",\n \"parameters\": [],\n \"format\": null,\n \"text\": \"Hi %%FIRST_NAME%%!\\n*Don't miss out* on our exclusive Black Friday promotion!\\n\\nGet your favorite white t-shirt at a fantastic *50% off*!\\n\\nThis is a limited-time offer, so make sure to grab yours before it's gone.\\n\\n*Shop now* and elevate your wardrobe with this essential piece.\"\n },\n \"footer_template_component\": {\n \"component_type\": \"footer\",\n \"parameters\": [],\n \"format\": null,\n \"text\": \"MyCompany\"\n },\n \"templatebuttoncomponent_set\": [\n {\n \"component_type\": null,\n \"text\": \"Shop Now\",\n \"order\": 0,\n \"button_type\": \"url\",\n \"phone_number\": null,\n \"form_id\": null,\n \"url\": \"https://myshop.com/my-product?coupon=MYCOUPON\",\n \"send_as_shortlink\": true\n },\n {\n \"component_type\": null,\n \"text\": \"Unsubscribe\",\n \"order\": 1,\n \"button_type\": \"unsubscribe\",\n \"phone_number\": null,\n \"form_id\": null,\n \"url\": null,\n \"send_as_shortlink\": null\n }\n ],\n \"example_custom_fields\": {\n \"FIRST_NAME\": \"John\"\n },\n \"example_header_media\": null,\n \"default_header_media\": null,\n \"templatecarouselcomponent_set\": []\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{Base-URL}}/api/1/templates/{{id}}/","description":"

Rate Limit: 10/min

Overview

Update an existing WhatsApp template. The PATCH endpoint follows the same structure as POST but allows partial updates and modifies an existing template instead of creating a new one.

\n","urlObject":{"path":["api","1","templates","{{id}}",""],"host":["{{Base-URL}}"],"query":[],"variable":[]}},"response":[{"id":"5298c69b-1959-4527-af40-9f47c82367f5","name":"200 OK","originalRequest":{"method":"PATCH","header":[{"key":"X-Spoki-Api-Key","value":"{{Api-Key}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"name\": \"black_friday_example\",\n \"category\": \"MARKETING\",\n \"subcategory\": \"CLASSIC\",\n \"template_groups\": [],\n \"templatelocalization_set\": [\n {\n \"id\": 12121212,\n \"language\": \"en\",\n \"status\": 0,\n \"header_template_component\": {\n \"component_type\": \"header\",\n \"parameters\": [],\n \"format\": \"text\",\n \"text\": \"Black Friday Special Offer!\"\n },\n \"body_template_component\": {\n \"component_type\": \"body\",\n \"parameters\": [],\n \"format\": null,\n \"text\": \"Hi %%FIRST_NAME%%!\\n*Don't miss out* on our exclusive Black Friday promotion!\\n\\nGet your favorite white t-shirt at a fantastic *50% off*!\\n\\nThis is a limited-time offer, so make sure to grab yours before it's gone.\\n\\n*Shop now* and elevate your wardrobe with this essential piece.\"\n },\n \"footer_template_component\": {\n \"component_type\": \"footer\",\n \"parameters\": [],\n \"format\": null,\n \"text\": \"MyCompany\"\n },\n \"templatebuttoncomponent_set\": [\n {\n \"component_type\": null,\n \"text\": \"Shop Now\",\n \"order\": 0,\n \"button_type\": \"url\",\n \"phone_number\": null,\n \"form_id\": null,\n \"url\": \"https://myshop.com/my-product?coupon=MYCOUPON\",\n \"send_as_shortlink\": true\n },\n {\n \"component_type\": null,\n \"text\": \"Unsubscribe\",\n \"order\": 1,\n \"button_type\": \"unsubscribe\",\n \"phone_number\": null,\n \"form_id\": null,\n \"url\": null,\n \"send_as_shortlink\": null\n }\n ],\n \"example_custom_fields\": {\n \"FIRST_NAME\": \"John\"\n },\n \"example_header_media\": null,\n \"default_header_media\": null,\n \"templatecarouselcomponent_set\": []\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{Base-URL}}/api/1/templates/{{id}}/"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"Server","value":"nginx/1.29.3"},{"key":"Date","value":"Mon, 10 Nov 2025 11:28:46 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"1304"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept, origin, Accept-Language, Cookie"},{"key":"Allow","value":"GET, PUT, PATCH, DELETE, HEAD, OPTIONS"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Language","value":"en"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"Strict-Transport-Security","value":"max-age=31536000"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 2449,\n \"name\": \"black_friday_example\",\n \"category\": \"MARKETING\",\n \"subcategory\": \"CLASSIC\",\n \"integration\": -1,\n \"is_approved\": false,\n \"is_favorite\": false,\n \"customfield_set\": [\n \"%%FIRST_NAME%%\"\n ],\n \"templatelocalization_set\": [\n {\n \"id\": 3252,\n \"language\": \"en\",\n \"status\": \"DRAFT\",\n \"rejection_reason\": null,\n \"default_header_media\": null,\n \"header_template_component\": {\n \"component_type\": \"header\",\n \"format\": \"text\",\n \"text\": \"Black Friday Special Offer!\"\n },\n \"body_template_component\": {\n \"component_type\": \"body\",\n \"format\": null,\n \"text\": \"Hi %%FIRST_NAME%%!\\n*Don't miss out* on our exclusive Black Friday promotion!\\n\\nGet your favorite white t-shirt at a fantastic *50% off*!\\n\\nThis is a limited-time offer, so make sure to grab yours before it's gone.\\n\\n*Shop now* and elevate your wardrobe with this essential piece.\"\n },\n \"footer_template_component\": {\n \"component_type\": \"footer\",\n \"format\": null,\n \"text\": \"MyCompany\"\n },\n \"templatebuttoncomponent_set\": [\n {\n \"order\": 0,\n \"button_type\": \"url\",\n \"text\": \"Shop Now\",\n \"phone_number\": null,\n \"url\": \"https://myshop.com/my-product?coupon=MYCOUPON\",\n \"form_id\": null,\n \"send_as_shortlink\": true,\n \"shortlink_code\": \"k6OvHQjOb4i1\"\n },\n {\n \"order\": 1,\n \"button_type\": \"unsubscribe\",\n \"text\": \"Unsubscribe\",\n \"phone_number\": null,\n \"url\": null,\n \"form_id\": null,\n \"send_as_shortlink\": false,\n \"shortlink_code\": null\n }\n ],\n \"templatecarouselcomponent_set\": []\n }\n ],\n \"template_groups\": []\n}"}],"_postman_id":"e8653467-6e21-4054-a1a4-74a01da1ca63"},{"name":"Request template","id":"7ed3aa26-2a0e-49f5-8377-96934ad525c8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"X-Spoki-Api-Key","value":"{{Api-Key}}","type":"text"}],"url":"{{Base-URL}}/api/1/templates/{{id}}/submit/","description":"

Rate Limit: 10/min

Overview

Submit a template to WhatsApp for review and approval. This endpoint sends your template to WhatsApp's servers where it will be reviewed according to their messaging policies. Templates must be approved before they can be used to send messages.

How It Works

Submission Flow

Template Created (Status: DRAFT) ↓
\n
POST /templates/{id}/submit/ ↓
\n
Spoki validates template ↓
\n
Sent to WhatsApp provider ↓
\n
WhatsApp reviews template (24-48 hours typically) ↓
\n
Template Status: PENDING → APPROVED or REJECTED
\n

What Happens When You Submit

First-time submission (template has no twilio_id):

Validates that your account has a WhatsApp API provider configured
\n
Sends the entire template with all localizations to your provider
\n
Provider forwards to WhatsApp for review
\n
Template receives a provider ID from WhatsApp
\n
All localizations change from DRAFT to PENDING status
\n

Subsequent submissions (template already has twilio_id):

Only sends localizations with status DRAFT to provider
\n
Existing approved localizations remain unchanged
\n
New or modified localizations enter review
\n
Useful for adding new languages without affecting approved ones
\n

Prerequisites

Before You Submit

✅ Required:

WhatsApp API Provider configured - Your account must have a WhatsApp Business API provider set up
\n
Template in DRAFT status - Template or its localizations must be in DRAFT state
\n
Valid template structure - All required fields properly filled
\n
Category selected - Valid WhatsApp category assigned
\n
At least one localization - Template must have content in at least one language
\n
Example custom fields provided - Helps WhatsApp reviewers understand your template
\n

⚠️ Recommended:

Clear, policy-compliant content - Follow WhatsApp's messaging policies
\n
Proper button configuration - All buttons work and URLs are valid
\n

Error Responses

400 Bad Request - No WhatsApp Provider

{ \"code\": \"PREREQUISITE_NOT_MET\", \"message\": \"Prerequisites not met\", \"detail\": \"WhatsApp API Provider is not set for the account\"}

Cause: Your account doesn't have a WhatsApp Business API provider configuredSolution:

Configure a WhatsApp provider in your account settings
\n
Contact Spoki support to set up WhatsApp Business API
\n
Verify your WhatsApp Business Account is active
\n

400 Bad Request - Provider Submission Failed

{ \"error\": \"Template name already exists\"}

Common error messages:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Error	Cause	Solution
\"Template name already exists\"	Template with this name already exists at WhatsApp	Change template name to something unique
\"Invalid template format\"	Template structure doesn't meet WhatsApp requirements	Review and fix template structure
\"Invalid category\"	Category not accepted by provider	Use valid category (TRANSACTIONAL, MARKETING, OTP)
\"Missing required fields\"	Template missing required components	Add all required fields (at least body)
\"Invalid button configuration\"	Button setup violates WhatsApp rules	Fix button types, counts, or URLs
\"Media not found\"	Header media doesn't exist	Upload media before submitting
\"Provider API error\"	Issue communicating with WhatsApp provider	Retry submission, contact support if persists

404 Not Found

{ \"detail\": \"Not found.\"}

Cause: Template ID doesn't exist or doesn't belong to your account

Solution: Verify template ID is correct and belongs to your account

401 Unauthorized

{ \"code\": \"INVALID_REQUEST_HEADER\", \"message\": \"Invalid or missing API key\"}

Cause: Missing or invalid API key

Solution: Include valid API key in X-Api-Key header

Template Status Lifecycle

Status Flow

DRAFT → [submit] → PENDING/WAITING_FOR_REVIEW → [WhatsApp reviews] → APPROVED ✅ or REJECTED ❌

Status Reference

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Status	Code	Description	Actions Available
DRAFT	0	Not submitted yet	Submit, Edit, Delete
PENDING	1	In provider queue	View only
WAITING_FOR_REVIEW	2	WhatsApp reviewing	View only
APPROVED	3	Ready to use ✅	Send messages, Clone, Revert to draft
REJECTED	4	Not approved ❌	View reason, Revert to draft, Fix & resubmit
PAUSED	9	Temporarily paused	Contact support
FLAGGED	11	Under review	Limited use
DISABLED	14	Deactivated	Contact support

Can I Submit?

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Status	Submit Allowed?	Notes
DRAFT	✅ Yes	Primary submission
PENDING	❌ No	Already submitted
WAITING_FOR_REVIEW	❌ No	Under review
APPROVED	❌ No	Must revert to draft first
REJECTED	❌ No	Must revert to draft first

Can I Use for Messaging?

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Status	Send Messages?
DRAFT	❌ No
PENDING	❌ No
WAITING_FOR_REVIEW	❌ No
APPROVED	✅ Yes
REJECTED	❌ No
PAUSED	❌ No
FLAGGED	⚠️ Limited
DISABLED	❌ No

","urlObject":{"path":["api","1","templates","{{id}}","submit",""],"host":["{{Base-URL}}"],"query":[],"variable":[]}},"response":[{"id":"360054b9-e27f-4f59-81a0-315ea127f3d6","name":"204 No Content","originalRequest":{"method":"POST","header":[{"key":"X-Spoki-Api-Key","value":"{{Api-Key}}","type":"text"}],"url":"{{Base-URL}}/api/1/templates/{{id}}/submit/"},"status":"No Content","code":204,"_postman_previewlanguage":null,"header":[{"key":"Server","value":"nginx/1.29.3"},{"key":"Date","value":"Mon, 10 Nov 2025 11:43:57 GMT"},{"key":"Content-Length","value":"0"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept, origin, Accept-Language, Cookie"},{"key":"Allow","value":"POST, OPTIONS"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Language","value":"en"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"Strict-Transport-Security","value":"max-age=31536000"}],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"7ed3aa26-2a0e-49f5-8377-96934ad525c8"},{"name":"Back template to Draft","id":"9a75230f-13d5-4b05-b0fc-aad32088e327","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"X-Spoki-Api-Key","value":"{{Api-Key}}","type":"text"}],"url":"{{Base-URL}}/api/1/templates/{{id}}/back_to_draft/","description":"

Rate Limit: 10/min

Overview

Revert a template back to DRAFT status, removing it from WhatsApp's servers. This allows you to modify an approved or rejected template before resubmitting.

What It Does

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Action	Result
Deletes from WhatsApp provider	Template removed from Provider
Clears twilio_id	Set to null
Resets is_approved	Set to false
Clears rejection_reason	Set to null
Sets status	All localizations to DRAFT (0)

After reverting:

✅ Can edit template
\n
✅ Can resubmit
\n
❌ Cannot send messages
\n
⚠️ Template unavailable until reapproved
\n

When to Use

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Scenario	Use back_to_draft?	Alternative
Fix rejected template	✅ Yes	-
Update approved template content	✅ Yes	Clone if actively used
Change body/buttons/media	✅ Yes	Clone if actively used
Add custom fields	✅ Yes	Clone if actively used
Update name/groups only	❌ No	PATCH directly
Create variation	❌ No	Clone instead
Template actively sending	❌ No	Clone instead

Status Changes

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Before	After
status	APPROVED/REJECTED/PENDING	DRAFT (0)
is_approved	true/false	false
rejection_reason	Any	null
Localization status	Any	DRAFT (0)

Important Considerations

⚠️ Impact

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Impact Area	Effect
Active automations	May fail if template unavailable
Scheduled campaigns	Will fail to send
Live messaging	Immediately unavailable
Past messages	Unaffected
Downtime	1-3 days (includes re-approval time)

Clone vs Revert

Use Clone when:

Template is actively used in campaigns
\n
Need to maintain uptime
\n
Testing variations
\n

Use Revert when:

Fixing rejected template
\n
Template not actively used
\n
Major content overhaul needed
\n

Best Practices

Check usage first - Verify template isn't in active campaigns
\n
Plan for downtime - 24-48 hours re-approval time
\n
Batch all changes - Make all edits before resubmitting
\n
Clone if active - Use clone for production templates
\n
Verify before reverting - Double-check template ID
\n

Checklist Before Reverting

[ ] Template is not used in active automations
\n
[ ] Not used in scheduled campaigns
\n
[ ] Have all changes ready to apply
\n
[ ] Team notified of downtime
\n
[ ] Considered cloning instead
\n

\n","urlObject":{"path":["api","1","templates","{{id}}","back_to_draft",""],"host":["{{Base-URL}}"],"query":[],"variable":[]}},"response":[{"id":"276a4901-3301-4b73-9343-c5b9a51f1021","name":"200 OK","originalRequest":{"method":"POST","header":[{"key":"X-Spoki-Api-Key","value":"{{Api-Key}}","type":"text"}],"url":"{{Base-URL}}/api/1/templates/{{id}}/back_to_draft/"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"Server","value":"nginx/1.29.3"},{"key":"Date","value":"Mon, 10 Nov 2025 11:53:20 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"15"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept, origin, Accept-Language, Cookie"},{"key":"Allow","value":"POST, OPTIONS"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Language","value":"en"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"Strict-Transport-Security","value":"max-age=31536000"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"ok\"\n}"}],"_postman_id":"9a75230f-13d5-4b05-b0fc-aad32088e327"},{"name":"Retrieve template","id":"9144a679-c7c9-41e4-b322-61f48a8fffd2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"X-Spoki-Api-Key","value":"{{Api-Key}}","type":"text"}],"url":"{{Base-URL}}/api/1/templates/{{id}}/","description":"

Returns a single template by its ID.

Templates are matched by Template.waba == channel.client_id. The optional channel_id query parameter can be used to assert that the template belongs to a specific channel — useful when managing multiple WABAs.

Path Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`id`	number	Yes	The unique identifier of the template to retrieve.

Query Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`channel_id`	number	No	Assert that the template's `waba` matches the given channel's `client_id`. The channel is validated before the lookup — see error responses below.

channel_id Validation

When channel_id is provided, the following checks are applied in order:

Non-numeric or cross-tenant → 404 { \"code\": \"spoki::404\", \"detail\": \"Channel not found\" }
Not a WhatsApp channel → 400 { \"detail\": \"Channel must be a WhatsApp channel\" }
Not ACTIVE (status ≠ Active) → 400 { \"detail\": \"Channel must be active\" }

Example Requests

GET /api/1/templates/101/\n→ 200  single template object\n\nGET /api/1/templates/101/?channel_id=17\n→ 200  template scoped to channel 17's WABA\n\nGET /api/1/templates/101/?channel_id=7   (cross-tenant)\n→ 404  { \"code\": \"spoki::404\", \"detail\": \"Channel not found\" }\n

Multi-WABA Caller Pattern

For callers managing multiple WABAs, use the following two-request pattern:

GET /channel/?whatsapp_business_account=<waba_id> → pick the row whose status == 3 (Active)
GET /templates/<id>/?channel_id=<picked.id>

Response (200 OK)

{\n  \"id\": 101,\n  \"name\": \"promo_spring\",\n  \"language\": \"it\",\n  \"category\": \"MARKETING\",\n  \"status\": \"APPROVED\",\n  \"waba\": \"123456789\",\n  \"components\": [\n    { \"type\": \"BODY\", \"text\": \"Scopri le nostre offerte primaverili!\" }\n  ]\n}\n

\n","urlObject":{"path":["api","1","templates","{{id}}",""],"host":["{{Base-URL}}"],"query":[],"variable":[]}},"response":[{"id":"7e6a394c-7382-499c-8928-62e28386318b","name":"200 OK","originalRequest":{"method":"GET","header":[{"key":"X-Spoki-Api-Key","value":"{{Api-Key}}","type":"text"}],"url":"{{Base-URL}}/api/1/templates/{{id}}/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.14.0 (Ubuntu)"},{"key":"Date","value":"Thu, 01 Jun 2023 14:36:45 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"668"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept, Origin, Cookie"},{"key":"Allow","value":"GET, HEAD, OPTIONS"},{"key":"X-Frame-Options","value":"DENY"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Strict-Transport-Security","value":"max-age=31536000"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 260,\n \"name\": \"promo_costumi\",\n \"category\": \"ACCOUNT_UPDATE\",\n \"is_approved\": true,\n \"is_favorite\": false,\n \"customfield_set\": [],\n \"templatelocalization_set\": [\n {\n \"language\": \"it\",\n \"status\": \"APPROVED\",\n \"rejection_reason\": null,\n \"header\": null,\n \"body\": {\n \"component_type\": \"body\",\n \"format\": \"text\",\n \"text\": \"Ciao, abbiamo una bellissima notizia per te! 😍\\n\\nDa oggi *fino a fine mese* avrai la possibilità di acquistare *i tuoi costumi preferiti* a *metà prezzo* 🛍!\\n\\nSfoglia il catalogo e scegli il tuo modello preferito 👇\"\n },\n \"footer\": null,\n \"button_set\": [\n {\n \"order\": 0,\n \"button_type\": \"quick_reply\",\n \"text\": \"Guarda il Catalogo\",\n \"phone_number\": null,\n \"url\": null\n }\n ],\n \"default_header_media\": null\n }\n ]\n}"}],"_postman_id":"9144a679-c7c9-41e4-b322-61f48a8fffd2"},{"name":"Delete template","id":"4e07eda6-93cd-44f0-bfea-5edbc6e51c32","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"DELETE","header":[{"key":"X-Spoki-Api-Key","value":"{{Api-Key}}","type":"text"}],"url":"{{Base-URL}}/api/1/templates/{{id}}/","description":"

Rate Limit: 10/min

Overview

Delete a template from your account.

Automation Protection

Delete Scenarios

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Scenario	force_delete	Result
Not used in automations	Not needed	✅ Delete succeeds
Used in automations	false (default)	❌ Blocked, returns automation list
Used in automations	true	✅ Deletes + deactivates automation steps

force_delete=true Requirements

Must have role/access in all accounts where template is used
\n
Automation steps set to is_active=false
\n
Automations continue but skip deleted template steps
\n

When to Delete

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Scenario	Safe to Delete?	Notes
Draft/rejected templates	✅ Yes	No dependencies
Old clones/tests	✅ Yes	Clean up clutter
Superseded versions	✅ Yes	After migration complete
Used in active automations	⚠️ Careful	Use force_delete=true
Production templates	❌ No	Consider alternatives first

Decision Flow

DELETE /templates/{id}/ ↓
Is template used in automations? ↓
NO → ✅ Delete succeeds ↓
YES → force_delete=true? ↓
NO → ❌ Returns automation list (403) ↓
YES → Have access to accounts? ↓
YES → ✅ Delete succeeds, steps deactivated ↓
NO → ❌ Access denied (403)

Best Practices

✅ Check template usage before deleting
\n
✅ Remove from automations manually when possible
\n
✅ Use force_delete only when necessary
\n
✅ Keep backups (clone before deleting)
\n
⚠️ Verify access to all affected accounts
\n
❌ Don't force delete production templates without planning
\n

Alternatives to Deletion

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Instead of Delete	Use
Temporarily disable	POST /templates/{id}/back_to_draft/
Create new version	GET /templates/{id}/clone/
Update content	PATCH /templates/{id}/

\n","urlObject":{"path":["api","1","templates","{{id}}",""],"host":["{{Base-URL}}"],"query":[{"disabled":true,"key":"force_delete","value":"true"}],"variable":[]}},"response":[{"id":"1eaf564e-e874-4703-9260-a4c0f9d169d6","name":"200 OK","originalRequest":{"method":"DELETE","header":[{"key":"X-Spoki-Api-Key","value":"{{Api-Key}}","type":"text"}],"url":"{{Base-URL}}/api/1/templates/{{id}}/"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"Server","value":"nginx/1.29.3"},{"key":"Date","value":"Mon, 10 Nov 2025 11:59:59 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"16"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept, origin, Accept-Language, Cookie"},{"key":"Allow","value":"GET, PUT, PATCH, DELETE, HEAD, OPTIONS"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Language","value":"en"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"Strict-Transport-Security","value":"max-age=31536000"}],"cookie":[],"responseTime":null,"body":"\"delete success\""}],"_postman_id":"4e07eda6-93cd-44f0-bfea-5edbc6e51c32"}],"id":"47da0fed-b8a1-40b6-af5b-666149a5d845","_postman_id":"47da0fed-b8a1-40b6-af5b-666149a5d845","description":"","auth":{"type":"apikey","apikey":{"value":"{{Api-Key}}","key":""},"isInherited":true,"source":{"_postman_id":"b0f8e61f-7a2d-488c-8c5b-2835b092a3f9","id":"b0f8e61f-7a2d-488c-8c5b-2835b092a3f9","name":"Spoki API","type":"collection"}}},{"name":"Tickets","item":[{"name":"List, search, and filter tickets","id":"8b83183a-97d2-4a34-8281-8422e511fb52","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"X-Spoki-Api-Key","value":"{{Api-Key}}","type":"text"}],"url":"{{Base-URL}}/api/1/tickets/","description":"

Rate Limit: 10/min

\n","urlObject":{"path":["api","1","tickets",""],"host":["{{Base-URL}}"],"query":[{"disabled":true,"key":"","value":""}],"variable":[]}},"response":[{"id":"78d1417a-6491-4344-a482-23c305746913","name":"200 OK","originalRequest":{"method":"GET","header":[{"key":"X-Spoki-Api-Key","value":"{{Api-Key}}","type":"text"}],"url":{"raw":"{{Base-URL}}/api/1/tickets/","host":["{{Base-URL}}"],"path":["api","1","tickets",""],"query":[{"key":"","value":"","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 28 Aug 2023 12:29:14 GMT"},{"key":"Server","value":"WSGIServer/0.2 CPython/3.7.9"},{"key":"Content-Type","value":"application/json"},{"key":"Vary","value":"Accept, Origin, Cookie"},{"key":"Allow","value":"GET, POST, HEAD, OPTIONS"},{"key":"Server-Timing","value":"TimerPanel_utime;dur=2354.089000000158;desc=\"User CPU time\", TimerPanel_stime;dur=287.75900000005095;desc=\"System CPU time\", TimerPanel_total;dur=2641.848000000209;desc=\"Total CPU time\", TimerPanel_total_time;dur=2610.058069229126;desc=\"Elapsed time\", SQLPanel_sql_time;dur=14.770984649658203;desc=\"SQL 19 queries\", CachePanel_total_time;dur=2.125263214111328;desc=\"Cache 4 Calls\""},{"key":"Content-Length","value":"3943"},{"key":"X-Frame-Options","value":"DENY"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"}],"cookie":[],"responseTime":null,"body":"{\n \"count\": 1,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n {\n \"id\": 4121212,\n \"contact\": {\n \"id\": 42378,\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"phone\": \"+3933312345678\",\n \"email\": \"john.doe@domain.com\",\n \"has_invalid_phone\": false,\n \"language\": \"it\",\n \"chat_link\": \"https://spoki.app/chats/4c436818nfa44d3f88f7bf05577531pq\",\n \"role_set\": [\n {\n \"id\": 77234,\n \"user\": {\n \"id\": 62336,\n \"email\": \"mario.rossi@domain.com\",\n \"uid\": \"zqmN340exPVokfOlvTQq9CRP2R02\",\n \"firstname\": \"Mario\",\n \"surname\": \"Rossi\",\n \"image\": \"http://localhost:8000/media/users/e8b97413-aah8-4755-b341-d6537ff8bd65.jpg\",\n \"is_service\": false\n },\n \"role\": \"Owner\"\n }\n ]\n },\n \"title\": \"My ticket\",\n \"description\": \"Lorem *ipsum* dolor\",\n \"reference\": \"custom_ref\",\n \"status\": \"Open\",\n \"priority\": \"Medium\",\n \"owner\": {\n \"id\": 62336,\n \"email\": \"mario.rossi@domain.com\",\n \"uid\": \"zqmN340exPVokfOlvTQq9CRP2R02\",\n \"firstname\": \"Mario\",\n \"surname\": \"Rossi\",\n \"image\": \"http://localhost:8000/media/users/e8b97413-aah8-4755-b341-d6537ff8bd65.jpg\",\n \"is_service\": false\n },\n \"created_datetime\": \"2023-08-28T14:27:55.686774+02:00\",\n \"updated_datetime\": \"2023-08-28T14:28:39.877141+02:00\",\n \"closed_datetime\": null\n }\n ]\n}"}],"_postman_id":"8b83183a-97d2-4a34-8281-8422e511fb52"},{"name":"Create ticket","id":"4a14960d-7a4c-49a0-a051-beaca538af58","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"X-Spoki-Api-Key","value":"{{Api-Key}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"contact_phone\": \"{{phone}}\",\n \"title\": \"My ticket\",\n \"status\": \"Open\",\n \"priority\": \"Medium\",\n \"description\": \"Lorem *ipsum* dolor\",\n \"reference\": \"custom_ref\"\n}","options":{"raw":{"language":"json"}}},"url":"{{Base-URL}}/api/1/tickets/","description":"

Rate Limit: 120/min

Possible Error Codes:

In case the body isn't correct:

{\n    \"field\": [\n        \"Error description.\"\n    ]\n}\n\n

In case the body is correct, other error code:

{\n    \"type\": \"https://app.spoki.it/errors/spoki::3004\",\n    \"title\": \"The request body is not correct\",\n    \"code\": \"spoki::3004\",\n    \"status\": 400,\n    \"datail\": \"Invalid or no title specified. Use 'title'\"\n}\n\n

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Status	Code	Title	Datail
400	spoki::3004	The request body is not correct	Invalid or no contact specified Use 'contact_phone'.
400	spoki::3004	The request body is not correct	Invalid or no title specified. Use 'title'
400	spoki::3004	The request body is not correct	Invalid or no status specified. Use 'status'
400	spoki::3004	The request body is not correct	Invalid or no status specified. Use 'status'. Accepted values are OPEN, PENDING, WAITING_ON_CUSTOMER, RESOLVED, CLOSED
400	spoki::3004	The request body is not correct	Invalid or no priority specified. Use 'priority'. Accepted values are LOWEST, LOW, MEDIUM, HIGH, HIGHETS
400	spoki::3007	Invalid request header	Invalid or no account specified

","urlObject":{"path":["api","1","tickets",""],"host":["{{Base-URL}}"],"query":[],"variable":[]}},"response":[{"id":"f9d1c060-127c-4e0b-846a-84633e4be695","name":"201 Created","originalRequest":{"method":"POST","header":[{"key":"X-Spoki-Api-Key","value":"{{Api-Key}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"contact_phone\": \"{{phone}}\",\n \"title\": \"My ticket\",\n \"status\": \"Open\",\n \"priority\": \"Medium\",\n \"description\": \"Lorem *ipsum* dolor\",\n \"reference\": \"custom_ref\"\n}","options":{"raw":{"language":"json"}}},"url":"{{Base-URL}}/api/1/tickets/"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 28 Aug 2023 12:27:56 GMT"},{"key":"Server","value":"WSGIServer/0.2 CPython/3.7.9"},{"key":"Content-Type","value":"application/json"},{"key":"Vary","value":"Accept, Origin, Cookie"},{"key":"Allow","value":"GET, POST, HEAD, OPTIONS"},{"key":"Server-Timing","value":"TimerPanel_utime;dur=2221.6040000000703;desc=\"User CPU time\", TimerPanel_stime;dur=552.5239999999485;desc=\"System CPU time\", TimerPanel_total;dur=2774.128000000019;desc=\"Total CPU time\", TimerPanel_total_time;dur=2873.5029697418213;desc=\"Elapsed time\", SQLPanel_sql_time;dur=17.703533172607422;desc=\"SQL 14 queries\", CachePanel_total_time;dur=2.3651123046875;desc=\"Cache 4 Calls\""},{"key":"Content-Length","value":"991"},{"key":"X-Frame-Options","value":"DENY"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 4121212,\n \"contact\": {\n \"id\": 42378,\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"phone\": \"+3933312345678\",\n \"email\": \"john.doe@domain.com\",\n \"has_invalid_phone\": false,\n \"language\": \"it\",\n \"chat_link\": \"https://spoki.app/chats/4c436818nfa44d3f88f7bf05577531pq\",\n \"role_set\": [\n {\n \"id\": 77234,\n \"user\": {\n \"id\": 62336,\n \"email\": \"mario.rossi@domain.com\",\n \"uid\": \"zqmN340exPVokfOlvTQq9CRP2R02\",\n \"firstname\": \"Mario\",\n \"surname\": \"Rossi\",\n \"image\": \"http://localhost:8000/media/users/e8b97413-aah8-4755-b341-d6537ff8bd65.jpg\",\n \"is_service\": false\n },\n \"role\": \"Owner\"\n }\n ]\n },\n \"title\": \"My ticket\",\n \"description\": \"Lorem *ipsum* dolor\",\n \"reference\": \"custom_ref\",\n \"status\": \"Open\",\n \"priority\": \"Medium\",\n \"created_datetime\": \"2023-08-28T14:27:55.686774+02:00\",\n \"updated_datetime\": \"2023-08-28T14:27:55.686813+02:00\",\n \"closed_datetime\": null\n}"}],"_postman_id":"4a14960d-7a4c-49a0-a051-beaca538af58"},{"name":"Retrieve ticket","id":"86a75482-1a05-4aed-9e8b-0e36d908da8a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"X-Spoki-Api-Key","value":"{{Api-Key}}","type":"text"}],"url":"{{Base-URL}}/api/1/tickets/{{id}}/","description":"

Rate Limit: 10/min

\n","urlObject":{"path":["api","1","tickets","{{id}}",""],"host":["{{Base-URL}}"],"query":[],"variable":[]}},"response":[{"id":"3be4391a-f171-4857-ba7a-bd582da7c44f","name":"200 OK","originalRequest":{"method":"GET","header":[{"key":"X-Spoki-Api-Key","value":"{{Api-Key}}","type":"text"}],"url":"{{Base-URL}}/api/1/tickets/{{id}}/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 28 Aug 2023 12:28:24 GMT"},{"key":"Server","value":"WSGIServer/0.2 CPython/3.7.9"},{"key":"Content-Type","value":"application/json"},{"key":"Vary","value":"Accept, Origin, Cookie"},{"key":"Allow","value":"GET, PUT, PATCH, DELETE, HEAD, OPTIONS"},{"key":"Server-Timing","value":"TimerPanel_utime;dur=1307.0129999998699;desc=\"User CPU time\", TimerPanel_stime;dur=217.5359999999955;desc=\"System CPU time\", TimerPanel_total;dur=1524.5489999998654;desc=\"Total CPU time\", TimerPanel_total_time;dur=1453.8509845733643;desc=\"Elapsed time\", SQLPanel_sql_time;dur=5.584955215454102;desc=\"SQL 6 queries\", CachePanel_total_time;dur=4.088401794433594;desc=\"Cache 4 Calls\""},{"key":"Content-Length","value":"991"},{"key":"X-Frame-Options","value":"DENY"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 4121212,\n \"contact\": {\n \"id\": 42378,\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"phone\": \"+3933312345678\",\n \"email\": \"john.doe@domain.com\",\n \"has_invalid_phone\": false,\n \"language\": \"it\",\n \"chat_link\": \"https://spoki.app/chats/4c436818nfa44d3f88f7bf05577531pq\",\n \"role_set\": [\n {\n \"id\": 77234,\n \"user\": {\n \"id\": 62336,\n \"email\": \"mario.rossi@domain.com\",\n \"uid\": \"zqmN340exPVokfOlvTQq9CRP2R02\",\n \"firstname\": \"Mario\",\n \"surname\": \"Rossi\",\n \"image\": \"http://localhost:8000/media/users/e8b97413-aah8-4755-b341-d6537ff8bd65.jpg\",\n \"is_service\": false\n },\n \"role\": \"Owner\"\n }\n ]\n },\n \"title\": \"My ticket\",\n \"description\": \"Lorem *ipsum* dolor\",\n \"reference\": \"custom_ref\",\n \"status\": \"Open\",\n \"priority\": \"Medium\",\n \"created_datetime\": \"2023-08-28T14:27:55.686774+02:00\",\n \"updated_datetime\": \"2023-08-28T14:27:55.686813+02:00\",\n \"closed_datetime\": null\n}"}],"_postman_id":"86a75482-1a05-4aed-9e8b-0e36d908da8a"},{"name":"Update ticket","id":"69c46807-e089-4387-a99c-4f629da69ac7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"PATCH","header":[{"key":"X-Spoki-Api-Key","value":"{{Api-Key}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"contact_phone\": \"{{phone}}\",\n \"title\": \"My ticket\",\n \"status\": \"Open\",\n \"priority\": \"Medium\",\n \"description\": \"Lorem *ipsum* dolor\",\n \"reference\": \"custom_ref\"\n}","options":{"raw":{"language":"json"}}},"url":"{{Base-URL}}/api/1/tickets/{{id}}/","description":"

Rate Limit: 120/min

Possible Error Codes:

In case the body isn't correct:

{\n    \"field\": [\n        \"Error description.\"\n    ]\n}\n\n

In case the body is correct, other error code:

{\n    \"type\": \"https://app.spoki.it/errors/spoki::3004\",\n    \"title\": \"The request body is not correct\",\n    \"code\": \"spoki::3004\",\n    \"status\": 400,\n    \"datail\": \"Invalid or no title specified. Use 'title'\"\n}\n\n

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Status	Code	Title	Datail
400	spoki::3004	The request body is not correct	Invalid or no status specified. Use 'status'. Accepted values are OPEN, PENDING, WAITING_ON_CUSTOMER, RESOLVED, CLOSED
400	spoki::3004	The request body is not correct	Invalid or no priority specified. Use 'priority'. Accepted values are LOWEST, LOW, MEDIUM, HIGH, HIGHETS
400	spoki::3007	Invalid request header	Invalid or no account specified

","urlObject":{"path":["api","1","tickets","{{id}}",""],"host":["{{Base-URL}}"],"query":[],"variable":[]}},"response":[{"id":"00bbe078-0f4b-4120-8820-7e26a62243b9","name":"200 OK","originalRequest":{"method":"PATCH","header":[{"key":"X-Spoki-Api-Key","value":"{{Api-Key}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"contact_phone\": \"{{phone}}\",\n \"title\": \"My ticket\",\n \"status\": \"Open\",\n \"priority\": \"Medium\",\n \"description\": \"Lorem *ipsum* dolor\",\n \"reference\": \"custom_ref\"\n}","options":{"raw":{"language":"json"}}},"url":"{{Base-URL}}/api/1/tickets/{{id}}/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 28 Aug 2023 12:28:41 GMT"},{"key":"Server","value":"WSGIServer/0.2 CPython/3.7.9"},{"key":"Content-Type","value":"application/json"},{"key":"Vary","value":"Accept, Origin, Cookie"},{"key":"Allow","value":"GET, PUT, PATCH, DELETE, HEAD, OPTIONS"},{"key":"Server-Timing","value":"TimerPanel_utime;dur=1831.0979999998835;desc=\"User CPU time\", TimerPanel_stime;dur=219.61499999997613;desc=\"System CPU time\", TimerPanel_total;dur=2050.7129999998597;desc=\"Total CPU time\", TimerPanel_total_time;dur=2011.4519596099854;desc=\"Elapsed time\", SQLPanel_sql_time;dur=7.870674133300781;desc=\"SQL 10 queries\", CachePanel_total_time;dur=2.469301223754883;desc=\"Cache 4 Calls\""},{"key":"Content-Length","value":"991"},{"key":"X-Frame-Options","value":"DENY"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 4121212,\n \"contact\": {\n \"id\": 42378,\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"phone\": \"+3933312345678\",\n \"email\": \"john.doe@domain.com\",\n \"has_invalid_phone\": false,\n \"language\": \"it\",\n \"chat_link\": \"https://spoki.app/chats/4c436818nfa44d3f88f7bf05577531pq\",\n \"role_set\": [\n {\n \"id\": 77234,\n \"user\": {\n \"id\": 62336,\n \"email\": \"mario.rossi@domain.com\",\n \"uid\": \"zqmN340exPVokfOlvTQq9CRP2R02\",\n \"firstname\": \"Mario\",\n \"surname\": \"Rossi\",\n \"image\": \"http://localhost:8000/media/users/e8b97413-aah8-4755-b341-d6537ff8bd65.jpg\",\n \"is_service\": false\n },\n \"role\": \"Owner\"\n }\n ]\n },\n \"title\": \"My ticket\",\n \"description\": \"Lorem *ipsum* dolor\",\n \"reference\": \"custom_ref\",\n \"status\": \"Open\",\n \"priority\": \"Medium\",\n \"created_datetime\": \"2023-08-28T14:27:55.686774+02:00\",\n \"updated_datetime\": \"2023-08-28T14:28:39.877141+02:00\",\n \"closed_datetime\": null\n}"}],"_postman_id":"69c46807-e089-4387-a99c-4f629da69ac7"},{"name":"Delete ticket","id":"c8a0ae1f-b06f-4848-a76f-9ba1846337cc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"DELETE","header":[{"key":"X-Spoki-Api-Key","value":"{{Api-Key}}","type":"text"}],"url":"{{Base-URL}}/api/1/tickets/{{id}}/","description":"

Rate Limit: 60/min

Possible Error Codes:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Status	Code	Title	Datail
400	spoki::3007	Invalid request header	Invalid or no account specified

","urlObject":{"path":["api","1","tickets","{{id}}",""],"host":["{{Base-URL}}"],"query":[],"variable":[]}},"response":[{"id":"a3a32327-f606-4b8a-89ca-7df4128b4542","name":"204 No Content","originalRequest":{"method":"DELETE","header":[{"key":"X-Spoki-Api-Key","value":"{{Api-Key}}","type":"text"}],"url":"{{Base-URL}}/api/1/tickets/{{id}}/"},"status":"No Content","code":204,"_postman_previewlanguage":"plain","header":[{"key":"Date","value":"Mon, 28 Aug 2023 12:30:09 GMT"},{"key":"Server","value":"WSGIServer/0.2 CPython/3.7.9"},{"key":"Vary","value":"Accept, Origin, Cookie"},{"key":"Allow","value":"GET, PUT, PATCH, DELETE, HEAD, OPTIONS"},{"key":"Server-Timing","value":"TimerPanel_utime;dur=1123.7280000000283;desc=\"User CPU time\", TimerPanel_stime;dur=193.74900000002526;desc=\"System CPU time\", TimerPanel_total;dur=1317.4770000000535;desc=\"Total CPU time\", TimerPanel_total_time;dur=1266.9718265533447;desc=\"Elapsed time\", SQLPanel_sql_time;dur=18.163681030273438;desc=\"SQL 5 queries\", CachePanel_total_time;dur=2.4340152740478516;desc=\"Cache 4 Calls\""},{"key":"Content-Length","value":"0"},{"key":"X-Frame-Options","value":"DENY"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"}],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"c8a0ae1f-b06f-4848-a76f-9ba1846337cc"}],"id":"473c167a-f5b3-453e-9e52-2905915b19cc","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"id":"80e404ff-9b36-4af5-b381-528f2a11cc4b","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"8eee7611-fbc0-40e7-aa2c-5536c8e7064b","type":"text/javascript","exec":[""]}}],"_postman_id":"473c167a-f5b3-453e-9e52-2905915b19cc","description":""},{"name":"Media","item":[{"name":"List, search, and filter media","id":"f516f904-bdf7-42b5-af0a-9a0a39d2a84a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"X-Spoki-Api-Key","value":"{{Api-Key}}","type":"text"}],"url":"{{Base-URL}}/api/1/media/","description":"

Rate Limit: 10/min

\n","urlObject":{"path":["api","1","media",""],"host":["{{Base-URL}}"],"query":[{"disabled":true,"key":"","value":""}],"variable":[]}},"response":[{"id":"53451d3e-2ea5-4dd1-b2ff-622f7ba88ea7","name":"200 OK","originalRequest":{"method":"GET","header":[{"key":"X-Spoki-Api-Key","value":"{{Api-Key}}","type":"text"}],"url":{"raw":"{{Base-URL}}/api/1/media/","host":["{{Base-URL}}"],"path":["api","1","media",""],"query":[{"key":"","value":"","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 28 Aug 2023 12:29:14 GMT"},{"key":"Server","value":"WSGIServer/0.2 CPython/3.7.9"},{"key":"Content-Type","value":"application/json"},{"key":"Vary","value":"Accept, Origin, Cookie"},{"key":"Allow","value":"GET, POST, HEAD, OPTIONS"},{"key":"Server-Timing","value":"TimerPanel_utime;dur=2354.089000000158;desc=\"User CPU time\", TimerPanel_stime;dur=287.75900000005095;desc=\"System CPU time\", TimerPanel_total;dur=2641.848000000209;desc=\"Total CPU time\", TimerPanel_total_time;dur=2610.058069229126;desc=\"Elapsed time\", SQLPanel_sql_time;dur=14.770984649658203;desc=\"SQL 19 queries\", CachePanel_total_time;dur=2.125263214111328;desc=\"Cache 4 Calls\""},{"key":"Content-Length","value":"3943"},{"key":"X-Frame-Options","value":"DENY"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"}],"cookie":[],"responseTime":null,"body":"{\n \"count\": 1,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n {\n \"id\": 1234,\n \"title\": \"External Image\",\n \"media\": null,\n \"content_type\": \"image/jpeg\",\n \"format_type\": \"image\",\n \"external_url\": \"https://example.com/my_image.jpg\",\n \"external_id\": null,\n \"is_deleted\": false\n }\n ]\n}"}],"_postman_id":"f516f904-bdf7-42b5-af0a-9a0a39d2a84a"},{"name":"Create media","id":"b7826838-a9a4-4542-bc55-000dd95ef78d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"X-Spoki-Api-Key","value":"{{Api-Key}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"title\": \"External Image\",\n \"external_url\": \"https://example.com/my_image.jpg\",\n \"format_type\": \"image\",\n \"content_type\": \"image/jpeg\"\n}","options":{"raw":{"language":"json"}}},"url":"{{Base-URL}}/api/1/media/","description":"

Rate Limit: 120/min

Possible Error Codes:

In case the body isn't correct:

{\n    \"field\": [\n        \"Error description.\"\n    ]\n}\n\n

In case the body is correct, other error code:

{\n    \"type\": \"https://app.spoki.it/errors/spoki::3004\",\n    \"title\": \"The request body is not correct\",\n    \"code\": \"spoki::3004\",\n    \"status\": 400,\n    \"datail\": \"Invalid or no title specified. Use 'title'\"\n}\n\n

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Status	Code	Title	Datail
400	spoki::3004	The request body is not correct	Invalid or no contact specified Use 'contact_phone'.
400	spoki::3004	The request body is not correct	Invalid or no title specified. Use 'title'
400	spoki::3004	The request body is not correct	Invalid or no status specified. Use 'status'
400	spoki::3004	The request body is not correct	Invalid or no status specified. Use 'status'. Accepted values are OPEN, PENDING, WAITING_ON_CUSTOMER, RESOLVED, CLOSED
400	spoki::3004	The request body is not correct	Invalid or no priority specified. Use 'priority'. Accepted values are LOWEST, LOW, MEDIUM, HIGH, HIGHETS
400	spoki::3007	Invalid request header	Invalid or no account specified

","urlObject":{"path":["api","1","media",""],"host":["{{Base-URL}}"],"query":[],"variable":[]}},"response":[{"id":"be23f179-2f40-43e8-8132-3ef5de8b52ef","name":"201 Created","originalRequest":{"method":"POST","header":[{"key":"X-Spoki-Api-Key","value":"{{Api-Key}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"title\": \"External Image\",\n \"external_url\": \"https://example.com/my_image.jpg\",\n \"format_type\": \"image\",\n \"content_type\": \"image/jpeg\"\n}","options":{"raw":{"language":"json"}}},"url":"{{Base-URL}}/api/1/media/{{id}}/"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 28 Aug 2023 12:27:56 GMT"},{"key":"Server","value":"WSGIServer/0.2 CPython/3.7.9"},{"key":"Content-Type","value":"application/json"},{"key":"Vary","value":"Accept, Origin, Cookie"},{"key":"Allow","value":"GET, POST, HEAD, OPTIONS"},{"key":"Server-Timing","value":"TimerPanel_utime;dur=2221.6040000000703;desc=\"User CPU time\", TimerPanel_stime;dur=552.5239999999485;desc=\"System CPU time\", TimerPanel_total;dur=2774.128000000019;desc=\"Total CPU time\", TimerPanel_total_time;dur=2873.5029697418213;desc=\"Elapsed time\", SQLPanel_sql_time;dur=17.703533172607422;desc=\"SQL 14 queries\", CachePanel_total_time;dur=2.3651123046875;desc=\"Cache 4 Calls\""},{"key":"Content-Length","value":"991"},{"key":"X-Frame-Options","value":"DENY"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 1234,\n \"title\": \"External Image\",\n \"media\": null,\n \"content_type\": \"image/jpeg\",\n \"format_type\": \"image\",\n \"external_url\": \"https://example.com/my_image.jpg\",\n \"external_id\": null,\n \"is_deleted\": false\n}"}],"_postman_id":"b7826838-a9a4-4542-bc55-000dd95ef78d"},{"name":"Retrieve media","id":"5f450e7c-cf9b-408e-bc64-d3a92aef97e3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"X-Spoki-Api-Key","value":"{{Api-Key}}","type":"text"}],"url":"{{Base-URL}}/api/1/media/{{id}}/","description":"

Rate Limit: 10/min

\n","urlObject":{"path":["api","1","media","{{id}}",""],"host":["{{Base-URL}}"],"query":[],"variable":[]}},"response":[{"id":"9910d051-108b-4087-b787-ed60e3af88f1","name":"200 OK","originalRequest":{"method":"GET","header":[{"key":"X-Spoki-Api-Key","value":"{{Api-Key}}","type":"text"}],"url":"{{Base-URL}}/api/1/media/{{id}}/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 28 Aug 2023 12:28:24 GMT"},{"key":"Server","value":"WSGIServer/0.2 CPython/3.7.9"},{"key":"Content-Type","value":"application/json"},{"key":"Vary","value":"Accept, Origin, Cookie"},{"key":"Allow","value":"GET, PUT, PATCH, DELETE, HEAD, OPTIONS"},{"key":"Server-Timing","value":"TimerPanel_utime;dur=1307.0129999998699;desc=\"User CPU time\", TimerPanel_stime;dur=217.5359999999955;desc=\"System CPU time\", TimerPanel_total;dur=1524.5489999998654;desc=\"Total CPU time\", TimerPanel_total_time;dur=1453.8509845733643;desc=\"Elapsed time\", SQLPanel_sql_time;dur=5.584955215454102;desc=\"SQL 6 queries\", CachePanel_total_time;dur=4.088401794433594;desc=\"Cache 4 Calls\""},{"key":"Content-Length","value":"991"},{"key":"X-Frame-Options","value":"DENY"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 1234,\n \"title\": \"External Image\",\n \"media\": null,\n \"content_type\": \"image/jpeg\",\n \"format_type\": \"image\",\n \"external_url\": \"https://example.com/my_image.jpg\",\n \"external_id\": null,\n \"is_deleted\": false\n}"}],"_postman_id":"5f450e7c-cf9b-408e-bc64-d3a92aef97e3"},{"name":"Update media","id":"15381626-80f3-424e-b50e-e43258509943","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"PATCH","header":[{"key":"X-Spoki-Api-Key","value":"{{Api-Key}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"title\": \"External Image A\"\n}","options":{"raw":{"language":"json"}}},"url":"{{Base-URL}}/api/1/media/{{id}}/","description":"

Rate Limit: 120/min

Possible Error Codes:

In case the body isn't correct:

{\n    \"field\": [\n        \"Error description.\"\n    ]\n}\n\n

In case the body is correct, other error code:

{\n    \"type\": \"https://app.spoki.it/errors/spoki::3004\",\n    \"title\": \"The request body is not correct\",\n    \"code\": \"spoki::3004\",\n    \"status\": 400,\n    \"datail\": \"Invalid or no title specified. Use 'title'\"\n}\n\n

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Status	Code	Title	Datail
400	spoki::3004	The request body is not correct	Invalid or no status specified. Use 'status'. Accepted values are OPEN, PENDING, WAITING_ON_CUSTOMER, RESOLVED, CLOSED
400	spoki::3004	The request body is not correct	Invalid or no priority specified. Use 'priority'. Accepted values are LOWEST, LOW, MEDIUM, HIGH, HIGHETS
400	spoki::3007	Invalid request header	Invalid or no account specified

","urlObject":{"path":["api","1","media","{{id}}",""],"host":["{{Base-URL}}"],"query":[],"variable":[]}},"response":[{"id":"7ad1cac8-eec9-4a1c-83c5-c0e4f7241794","name":"200 OK","originalRequest":{"method":"PATCH","header":[{"key":"X-Spoki-Api-Key","value":"{{Api-Key}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"title\": \"External Image A\"\n}","options":{"raw":{"language":"json"}}},"url":"{{Base-URL}}/api/1/media/{{id}}/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 28 Aug 2023 12:28:41 GMT"},{"key":"Server","value":"WSGIServer/0.2 CPython/3.7.9"},{"key":"Content-Type","value":"application/json"},{"key":"Vary","value":"Accept, Origin, Cookie"},{"key":"Allow","value":"GET, PUT, PATCH, DELETE, HEAD, OPTIONS"},{"key":"Server-Timing","value":"TimerPanel_utime;dur=1831.0979999998835;desc=\"User CPU time\", TimerPanel_stime;dur=219.61499999997613;desc=\"System CPU time\", TimerPanel_total;dur=2050.7129999998597;desc=\"Total CPU time\", TimerPanel_total_time;dur=2011.4519596099854;desc=\"Elapsed time\", SQLPanel_sql_time;dur=7.870674133300781;desc=\"SQL 10 queries\", CachePanel_total_time;dur=2.469301223754883;desc=\"Cache 4 Calls\""},{"key":"Content-Length","value":"991"},{"key":"X-Frame-Options","value":"DENY"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 1234,\n \"title\": \"External Image A\",\n \"media\": null,\n \"content_type\": \"image/jpeg\",\n \"format_type\": \"image\",\n \"external_url\": \"https://example.com/my_image.jpg\",\n \"external_id\": null,\n \"is_deleted\": false\n}"}],"_postman_id":"15381626-80f3-424e-b50e-e43258509943"},{"name":"Delete media","id":"bc5732fd-ea45-4213-9f6a-23d9187922e8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"DELETE","header":[{"key":"X-Spoki-Api-Key","value":"{{Api-Key}}","type":"text"}],"url":"{{Base-URL}}/api/1/media/{{id}}/","description":"

Rate Limit: 60/min

Possible Error Codes:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Status	Code	Title	Datail
400	spoki::3007	Invalid request header	Invalid or no account specified

","urlObject":{"path":["api","1","media","{{id}}",""],"host":["{{Base-URL}}"],"query":[],"variable":[]}},"response":[{"id":"dd591268-4128-436f-a8a1-2392ab6892a5","name":"204 No Content","originalRequest":{"method":"DELETE","header":[{"key":"X-Spoki-Api-Key","value":"{{Api-Key}}","type":"text"}],"url":"{{Base-URL}}/api/1/media/{{id}}/"},"status":"No Content","code":204,"_postman_previewlanguage":"plain","header":[{"key":"Date","value":"Mon, 28 Aug 2023 12:30:09 GMT"},{"key":"Server","value":"WSGIServer/0.2 CPython/3.7.9"},{"key":"Vary","value":"Accept, Origin, Cookie"},{"key":"Allow","value":"GET, PUT, PATCH, DELETE, HEAD, OPTIONS"},{"key":"Server-Timing","value":"TimerPanel_utime;dur=1123.7280000000283;desc=\"User CPU time\", TimerPanel_stime;dur=193.74900000002526;desc=\"System CPU time\", TimerPanel_total;dur=1317.4770000000535;desc=\"Total CPU time\", TimerPanel_total_time;dur=1266.9718265533447;desc=\"Elapsed time\", SQLPanel_sql_time;dur=18.163681030273438;desc=\"SQL 5 queries\", CachePanel_total_time;dur=2.4340152740478516;desc=\"Cache 4 Calls\""},{"key":"Content-Length","value":"0"},{"key":"X-Frame-Options","value":"DENY"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"}],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"bc5732fd-ea45-4213-9f6a-23d9187922e8"}],"id":"5454cac0-8f47-44ce-9e5a-ecddbd651322","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"id":"80e404ff-9b36-4af5-b381-528f2a11cc4b","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"8eee7611-fbc0-40e7-aa2c-5536c8e7064b","type":"text/javascript","exec":[""]}}],"_postman_id":"5454cac0-8f47-44ce-9e5a-ecddbd651322","description":""},{"name":"Webhooks","item":[{"name":"API","item":[{"name":"List, search, and filter webhooks","id":"966164e0-f7bf-4705-ad2e-cafc8ea973d2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"X-Spoki-Api-Key","value":"{{Api-Key}}","type":"text"}],"url":"{{Base-URL}}/api/1/external-webhooks/","description":"

Rate Limit: 30/min

Returns a list of webhooks for the authenticated account.

Response

[\n    {\n        \"id\": 123,\n        \"version\": 2,\n        \"url\": \"https://example.com/webhook\",\n        \"event\": \"message.inbound\",\n        \"is_active\": true,\n        \"account\": 456,\n        \"secret\": \"whsec_a1b2c3...\",\n        \"requested_expands\": [\"contact\"],\n        \"approved_expands\": [\"contact\"]\n    }\n]\n

\n","urlObject":{"path":["api","1","external-webhooks",""],"host":["{{Base-URL}}"],"query":[{"disabled":true,"description":{"content":"

true | false

\n","type":"text/plain"},"key":"is_active","value":""},{"disabled":true,"description":{"content":"

Possible events:\nchat.has_unread_messages\nmessage.outbound\nmessage.inbound\nmessage.note\ncontact.created\ncontact.updated\ncontact.deleted\ncontact_tag.created\ncontact_tag.deleted\ncontact_list.created\ncontact_list.deleted\ncontact_field.created_or_updated\ncontact_field.deleted\nform_answer.submitted\ntemplate.created\ntemplate.updated\ntemplate.deleted\nchannel.whatsapp.status\nchannel.sms_one_way.status\nchannel.sms_two_way.status\nchannel.whatsapp.violation\nchannel.whatsapp.restriction\nchannel.whatsapp.tier_changed\nchannel.activation\ncampaign.created\ncampaign.deleted\ncampaign.status_changed

\n","type":"text/plain"},"key":"event","value":""}],"variable":[]}},"response":[{"id":"90b6bc5c-1efe-4c20-9c98-886262ef6e26","name":"200 OK","originalRequest":{"method":"GET","header":[{"key":"X-Spoki-Api-Key","value":"{{Api-Key}}","type":"text"}],"url":{"raw":"{{Base-URL}}/api/1/external-webhooks/","host":["{{Base-URL}}"],"path":["api","1","external-webhooks",""],"query":[{"key":"","value":"","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"Server","value":"nginx/1.29.1"},{"key":"Date","value":"Tue, 23 Sep 2025 13:32:09 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"176"},{"key":"Connection","value":"keep-alive"},{"key":"Allow","value":"GET, POST, HEAD, OPTIONS"},{"key":"Vary","value":"origin, Accept-Language, Cookie"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Language","value":"en"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"Strict-Transport-Security","value":"max-age=31536000"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": 1796,\n \"version\": 1,\n \"url\": \"https://example.com/webhook\",\n \"event\": \"chat.has_unread_messages\",\n \"is_active\": true,\n \"account\": 1384,\n \"secret\": \"46b3f28e-9349-424a-9f05-4fdc96bbf354\"\n }\n]"},{"id":"0e4d0f22-805f-48ed-95ac-d91884822aed","name":"200 OK (Filter)","originalRequest":{"method":"GET","header":[{"key":"X-Spoki-Api-Key","value":"{{Api-Key}}","type":"text"}],"url":{"raw":"{{Base-URL}}/api/1/external-webhooks/?is_active=true&event=chat.has_unread_messages","host":["{{Base-URL}}"],"path":["api","1","external-webhooks",""],"query":[{"key":"is_active","value":"true"},{"key":"event","value":"chat.has_unread_messages","type":"text"}]}},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"Server","value":"nginx/1.29.1"},{"key":"Date","value":"Tue, 23 Sep 2025 13:46:00 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"176"},{"key":"Connection","value":"keep-alive"},{"key":"Allow","value":"GET, POST, HEAD, OPTIONS"},{"key":"Vary","value":"origin, Accept-Language, Cookie"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Language","value":"en"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"Strict-Transport-Security","value":"max-age=31536000"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": 1797,\n \"version\": 1,\n \"url\": \"https://example.com/webhook\",\n \"event\": \"chat.has_unread_messages\",\n \"is_active\": true,\n \"account\": 1384,\n \"secret\": \"46b3f28e-9349-424a-9f05-4fdc96bbf354\"\n }\n]"}],"_postman_id":"966164e0-f7bf-4705-ad2e-cafc8ea973d2"},{"name":"Create webhook","id":"24636aae-68e8-497d-81a9-0727fb4c4403","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"X-Spoki-Api-Key","value":"{{Api-Key}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"event\": \"{{event_type}}\",\n \"version\": 2,\n \"url\": \"https://example.com/webhook\",\n \"is_active\": true\n}","options":{"raw":{"language":"json"}}},"url":"{{Base-URL}}/api/1/external-webhooks/","description":"

Create External Webhook

Endpoint

POST /api/wh/external_webhooks/

Rate Limit

30/min

Description

Creates a new webhook for the authenticated account.

Version

Set version to 2 (recommended) for the latest webhook format with:

HMAC-SHA256 signature via X-Spoki-Signature header
\n
Expand system to customize payload fields
\n
Secret token auto-generated as whsec_... (256-bit entropy)
\n

Set version to 1 for the legacy format (PBKDF2 signature via X-SPOKI-HASH header).

Request Body

{\n    \"version\": 2,\n    \"url\": \"https://example.com/webhook\",\n    \"event\": \"message.inbound\",\n    \"is_active\": true\n}\n\n

Possible Event Types

chat.has_unread_messages
\n
message.outbound
\n
message.inbound
\n
message.note
\n
contact.created
\n
contact.updated
\n
contact.deleted
\n
contact_tag.created
\n
contact_tag.deleted
\n
contact_list.created
\n
contact_list.deleted
\n
contact_field.created_or_updated
\n
contact_field.deleted
\n
form_answer.submitted
\n
template.created
\n
template.updated
\n
template.deleted
\n
channel.whatsapp.status
\n
channel.sms_one_way.status
\n
channel.sms_two_way.status
\n
channel.whatsapp.violation
\n
channel.whatsapp.restriction
\n
channel.whatsapp.tier_changed
\n
channel.activation
\n
campaign.created
\n
campaign.deleted
\n
campaign.status_changed
\n

Response

{\n    \"id\": 123,\n    \"version\": 2,\n    \"url\": \"https://example.com/webhook\",\n    \"event\": \"message.inbound\",\n    \"is_active\": true,\n    \"account\": 456,\n    \"secret\": \"whsec_a1b2c3d4...\",\n    \"requested_expands\": [],\n    \"approved_expands\": []\n}\n\n

Response Fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Description
`id`	integer	Webhook ID
`version`	integer	`1` or `2`
`url`	string	Delivery URL (max `2000` chars)
`event`	string	Event type
`is_active`	boolean	Whether the webhook is active
`account`	integer	Account ID (read-only)
`secret`	string	Webhook secret for signature verification (read-only, auto-generated)
`requested_expands`	string[]	Requested expand tokens (read-only, V2 only)
`approved_expands`	string[]	Approved expand tokens (read-only, V2 only)

Possible Error Codes

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Status	Code	Title	Detail
`400`	`spoki::400`	Unknown error	Invalid or no account specified

","urlObject":{"path":["api","1","external-webhooks",""],"host":["{{Base-URL}}"],"query":[],"variable":[]}},"response":[{"id":"bae01437-4fd6-47ae-bf7b-bff95bc1062e","name":"201 Created","originalRequest":{"method":"POST","header":[{"key":"X-Spoki-Api-Key","value":"{{Api-Key}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"event\": \"{{event_type}}\",\n \"version\": 1,\n \"url\": \"https://example.com/webhook\",\n \"is_active\": true\n}","options":{"raw":{"language":"json"}}},"url":"{{Base-URL}}/api/1/external-webhooks/"},"status":"Created","code":201,"_postman_previewlanguage":null,"header":[{"key":"Server","value":"nginx/1.29.1"},{"key":"Date","value":"Tue, 23 Sep 2025 13:31:19 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"174"},{"key":"Connection","value":"keep-alive"},{"key":"Location","value":"https://example.com/webhook"},{"key":"Allow","value":"GET, POST, HEAD, OPTIONS"},{"key":"Vary","value":"origin, Accept-Language, Cookie"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Language","value":"en"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"Strict-Transport-Security","value":"max-age=31536000"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 1796,\n \"version\": 1,\n \"url\": \"https://example.com/webhook\",\n \"event\": \"chat.has_unread_messages\",\n \"is_active\": true,\n \"account\": 1384,\n \"secret\": \"46b3f28e-9349-424a-9f05-4fdc96bbf354\"\n}"}],"_postman_id":"24636aae-68e8-497d-81a9-0727fb4c4403"},{"name":"Retrieve webhook","id":"58eea4f7-3f6a-491e-849e-7a60e9b403eb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-Spoki-Api-Key","value":"{{Api-Key}}","type":"text"}],"url":"{{Base-URL}}/api/1/external-webhooks/{{id}}/","description":"

Rate Limit: 30/min

\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"1aaf0d9e-9fd2-4358-b142-dbfcbc21dae1","id":"1aaf0d9e-9fd2-4358-b142-dbfcbc21dae1","name":"Webhooks","type":"folder"}},"urlObject":{"path":["api","1","external-webhooks","{{id}}",""],"host":["{{Base-URL}}"],"query":[],"variable":[]}},"response":[{"id":"b0f8e8d2-6225-4771-a3d7-e2149f4ad9d7","name":"200 OK","originalRequest":{"method":"GET","header":[{"key":"X-Spoki-Api-Key","value":"{{Api-Key}}","type":"text"}],"url":"{{Base-URL}}/api/1/external-webhooks/{{id}}/"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"Server","value":"nginx/1.29.1"},{"key":"Date","value":"Tue, 23 Sep 2025 13:32:38 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"174"},{"key":"Connection","value":"keep-alive"},{"key":"Allow","value":"GET, PUT, PATCH, DELETE, HEAD, OPTIONS"},{"key":"Vary","value":"origin, Accept-Language, Cookie"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Language","value":"en"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"Strict-Transport-Security","value":"max-age=31536000"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 1796,\n \"version\": 1,\n \"url\": \"https://example.com/webhook\",\n \"event\": \"chat.has_unread_messages\",\n \"is_active\": true,\n \"account\": 1384,\n \"secret\": \"46b3f28e-9349-424a-9f05-4fdc96bbf354\"\n}"}],"_postman_id":"58eea4f7-3f6a-491e-849e-7a60e9b403eb"},{"name":"Update webhook","id":"502e4c6b-50b8-4df2-8210-ed075b190261","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"PATCH","header":[{"key":"X-Spoki-Api-Key","value":"{{Api-Key}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"event\": \"{{event_type}}\",\n \"version\": 2,\n \"url\": \"https://example.com/webhook\",\n \"is_active\": true\n}","options":{"raw":{"language":"json"}}},"url":"{{Base-URL}}/api/1/external-webhooks/{{id}}/","description":"

Rate Limit: 30/min

Updates a webhook. Acts like a PATCH — only the fields you send are updated.

Note: You cannot downgrade the webhook version (e.g. from V2 to V1). If upgrading from V1 to V2, a new secret is automatically generated.

Possible Error Codes:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Status	Code	Title	Detail
400	spoki::400	Unknown error	Invalid or no account specified

","urlObject":{"path":["api","1","external-webhooks","{{id}}",""],"host":["{{Base-URL}}"],"query":[],"variable":[]}},"response":[{"id":"2d1e2ee9-0571-4e6b-b627-cb78769fc0a1","name":"200 OK","originalRequest":{"method":"PATCH","header":[{"key":"X-Spoki-Api-Key","value":"{{Api-Key}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"event\": \"{{event_type}}\",\n \"version\": 1,\n \"url\": \"https://example.com/webhook\",\n \"is_active\": true\n}","options":{"raw":{"language":"json"}}},"url":"{{Base-URL}}/api/1/external-webhooks/{{id}}/"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"Server","value":"nginx/1.29.1"},{"key":"Date","value":"Tue, 23 Sep 2025 13:32:50 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"174"},{"key":"Connection","value":"keep-alive"},{"key":"Allow","value":"GET, PUT, PATCH, DELETE, HEAD, OPTIONS"},{"key":"Vary","value":"origin, Accept-Language, Cookie"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Language","value":"en"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"Strict-Transport-Security","value":"max-age=31536000"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 1796,\n \"version\": 1,\n \"url\": \"https://example.com/webhook\",\n \"event\": \"chat.has_unread_messages\",\n \"is_active\": true,\n \"account\": 1384,\n \"secret\": \"46b3f28e-9349-424a-9f05-4fdc96bbf354\"\n}"}],"_postman_id":"502e4c6b-50b8-4df2-8210-ed075b190261"},{"name":"Delete webhook","id":"10c9ef46-ad8b-4e88-ac17-4c8d1867a4c5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"DELETE","header":[{"key":"X-Spoki-Api-Key","value":"{{Api-Key}}","type":"text"}],"url":"{{Base-URL}}/api/1/external-webhooks/{{id}}/","description":"

Rate Limit: 30/min

In case the body is correct, other error code:

{\n    \"type\": \"https://app.spoki.it/errors/spoki::400\",\n    \"title\": \"Unknown error\",\n    \"code\": \"spoki::400\",\n    \"status\": 400,\n    \"datail\": \"Invalid or no account specified\"\n}\n\n

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Status	Code	Title	Datail
400	spoki::400	Unknown error	Invalid or no account specified

","urlObject":{"path":["api","1","external-webhooks","{{id}}",""],"host":["{{Base-URL}}"],"query":[],"variable":[]}},"response":[{"id":"c06cfeb4-792a-44d8-9fa9-e538603b86e0","name":"204 No Content","originalRequest":{"method":"DELETE","header":[{"key":"X-Spoki-Api-Key","value":"{{Api-Key}}","type":"text"}],"url":"{{Base-URL}}/api/1/external-webhooks/{{id}}/"},"status":"No Content","code":204,"_postman_previewlanguage":null,"header":[{"key":"Server","value":"nginx/1.29.1"},{"key":"Date","value":"Tue, 23 Sep 2025 13:33:01 GMT"},{"key":"Content-Length","value":"0"},{"key":"Connection","value":"keep-alive"},{"key":"Allow","value":"GET, PUT, PATCH, DELETE, HEAD, OPTIONS"},{"key":"Vary","value":"origin, Accept-Language, Cookie"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Language","value":"en"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"Strict-Transport-Security","value":"max-age=31536000"}],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"10c9ef46-ad8b-4e88-ac17-4c8d1867a4c5"},{"name":"Get expands","id":"e9554726-2611-2d21-732f-b4e080fd4663","request":{"method":"GET","header":[],"url":"{{Base-URL}}/api/1/external-webhooks/{{id}}/expands/","description":"

Rate Limit: 30/min

V2 only. Returns the expand configuration for a webhook, including which tokens are requested, approved, and available.

Response

{\n    \"requested_expands\": [\"contact\", \"tag_set\"],\n    \"approved_expands\": [\"contact\"],\n    \"allowed_expands\": [\"contact\", \"sender\", \"tag_set\", \"list_set\", \"contactfield_set\", \"contactfield_values\"]\n}\n

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Description
requested_expands	string[]	Expand tokens requested by the account
approved_expands	string[]	Expand tokens approved and active
allowed_expands	string[]	All expand tokens available for this event type

Expand tokens

Some expand tokens are auto-approved (e.g. contact, sender, tag, list), while others require manual approval by Spoki (e.g. tag_set, list_set, contactfield_set, contactfield_values). Use the \"Set expands\" endpoint to request tokens.

Rate Limit: 30/min

V2 only. Request or update expand tokens for a webhook. Expand tokens add additional fields to the webhook payload.

Auto-approved / Requires manual approval

Some tokens are auto-approved and take effect immediately. Others require manual approval by Spoki and will appear in pending_approval until approved.

Expand tokens support a maximum nesting depth of 2 (e.g. contact.tag_set is allowed). First-level expansion tokens are automatically approved, second-level tokens require manual approval

Response

{\n    \"requested_expands\": [\"contact\", \"tag_set\"],\n    \"approved_expands\": [\"contact\"],\n    \"pending_approval\": [\"tag_set\"],\n    \"allowed_expands\": [\"contact\", \"sender\", \"tag_set\", \"list_set\", ...]\n}\n\n

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Description
requested_expands	string[]	All expand tokens you requested
approved_expands	string[]	Tokens currently approved and active
pending_approval	string[]	Tokens awaiting manual approval by Spoki
allowed_expands	string[]	All available tokens for this event type

","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"1aaf0d9e-9fd2-4358-b142-dbfcbc21dae1","id":"1aaf0d9e-9fd2-4358-b142-dbfcbc21dae1","name":"Webhooks","type":"folder"}},"urlObject":{"path":["api","1","external-webhooks","{{id}}","expands",""],"host":["{{Base-URL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"d286bd47-8d48-ec4a-4e47-6ddf51e8d3c0"},{"name":"Send test webhook","id":"0847c411-bb0c-7824-5a44-06cf2d04c5ca","request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{}","options":{"raw":{"language":"json"}}},"url":"{{Base-URL}}/api/1/external-webhooks/{{id}}/test/","description":"

Rate Limit: 30/min

Sends a test webhook event to validate your webhook setup. Creates a PENDING event and dispatches it asynchronously to your webhook URL with mock data matching the webhook's event type and version.

The test payload includes mocked data for all approved expand fields.

Response (202 Accepted)

{\n    \"event_id\": 456\n}\n

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Description
event_id	integer	ID of the test event created. Use the webhook events endpoint to check delivery status.

","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"1aaf0d9e-9fd2-4358-b142-dbfcbc21dae1","id":"1aaf0d9e-9fd2-4358-b142-dbfcbc21dae1","name":"Webhooks","type":"folder"}},"urlObject":{"path":["api","1","external-webhooks","{{id}}","test",""],"host":["{{Base-URL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"0847c411-bb0c-7824-5a44-06cf2d04c5ca"},{"name":"Rotate secret","id":"72a6e733-fd55-2d19-b4d7-94e570067bdb","request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{}","options":{"raw":{"language":"json"}}},"url":"{{Base-URL}}/api/1/external-webhooks/{{id}}/rotate_secret/","description":"

Rate Limit: 30/min

Generates a new secret for the webhook. The previous secret is immediately invalidated. Returns the full webhook object with the new secret field.

Use this if you suspect your webhook secret has been compromised, or to periodically rotate secrets.

Response (200 OK)

{\n    \"id\": 123,\n    \"version\": 2,\n    \"url\": \"https://example.com/webhook\",\n    \"event\": \"message.inbound\",\n    \"is_active\": true,\n    \"account\": 456,\n    \"secret\": \"whsec_new_secret_here...\",\n    \"requested_expands\": [\"contact\"],\n    \"approved_expands\": [\"contact\"]\n}\n

\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"1aaf0d9e-9fd2-4358-b142-dbfcbc21dae1","id":"1aaf0d9e-9fd2-4358-b142-dbfcbc21dae1","name":"Webhooks","type":"folder"}},"urlObject":{"path":["api","1","external-webhooks","{{id}}","rotate_secret",""],"host":["{{Base-URL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"72a6e733-fd55-2d19-b4d7-94e570067bdb"}],"id":"afd58e7e-7f20-46de-b9b1-cae4719019a7","_postman_id":"afd58e7e-7f20-46de-b9b1-cae4719019a7","description":"","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"1aaf0d9e-9fd2-4358-b142-dbfcbc21dae1","id":"1aaf0d9e-9fd2-4358-b142-dbfcbc21dae1","name":"Webhooks","type":"folder"}}},{"name":"Webhooks body content","item":[{"name":"Message received","item":[{"name":"Message Text received","id":"4fee6f34-be05-468d-aa36-24b016c094f7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"VIEW","header":[],"body":{"mode":"raw","raw":"{\n \"version\": 1,\n \"event\": \"message.inbound\",\n \"data\": {\n \"uuid\": \"b78213e075564866807dbd1780eaa09d\",\n \"delivered_datetime\": null,\n \"sent_datetime\": \"2023-05-12T12:59:21+02:00\",\n \"direction\": \"Inbound\",\n \"type\": \"Incoming Message\",\n \"content_type\": \"Text\",\n \"from_phone\": \"{{phone}}\",\n \"is_hidden\": false,\n \"send_status\": \"---\",\n \"send_error_message\": null,\n \"error_code\": null,\n \"error_url\": null,\n \"preview\": {\n \"body\": \"Thanks\"\n },\n \"to_phone\": \"{{to_phone}}\",\n \"text\": \"Thanks\",\n \"timestamp\": 1683889161466,\n \"created_datetime\": \"2023-05-12T10:59:21+00:00\",\n \"mediamessage_set\": [],\n \"locationmessage\": null,\n \"sender\": null,\n \"contactsmessage_set\": [],\n \"contact\": {\n \"id\": 42413,\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"phone\": \"{{phone}}\",\n \"email\": \"john.doe@domain.com\",\n \"language\": \"en\",\n \"has_invalid_phone\": false,\n \"chat_link\": \"https://spoki.app/chats/6490641ba9a049f49f95f1561c9bbe3c\",\n \"created_datetime\": \"2023-03-21T14:16:26.256109+01:00\",\n \"contactfield_set\": [\n {\n \"id\": 292850,\n \"field\": 440,\n \"code\": \"ACCOUNT_NAME\",\n \"visual_code\": \"%%ACCOUNT_NAME%%\",\n \"value\": \"MyShop\",\n \"value_datetime\": null\n }\n ],\n \"contactfield_values\": {\n \"ACCOUNT_NAME\": \"MyShop\"\n },\n \"tag_set\": [],\n \"list_set\": []\n },\n \"metadata\": {\n \"your_str_meta\": \"lorem ipsum\",\n \"your_int_meta\": 3,\n \"your_float_meta\": 42.5,\n \"your_bool_meta\": true\n },\n \"payload\": \"your_unique_optional_payload_given_if_this_text_is_form_a_button\"\n }\n}","options":{"raw":{"language":"json"}}},"description":"

This event is notified when a text message has been received.

V2 payload

In V2, the contact object (with tag_set, list_set, contactfield_set, contactfield_values) is not included by default. Request it via the expands API.

V2 default fields: uuid, delivered_datetime, sent_datetime, direction, type, content_type, from_phone, to_phone, text, is_hidden, send_status, send_error_message, error_code, error_url, preview, timestamp, created_datetime, chat_link, contact_id, contact_ref, mediamessage_set, locationmessage, contactsmessage_set, metadata, payload

Available expands: contact, contact.tag_set, contact.list_set, contact.role_set, contact.contactfield_set, contact.contactfield_values

\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"1aaf0d9e-9fd2-4358-b142-dbfcbc21dae1","id":"1aaf0d9e-9fd2-4358-b142-dbfcbc21dae1","name":"Webhooks","type":"folder"}},"urlObject":{"query":[],"variable":[]},"url":""},"response":[],"_postman_id":"4fee6f34-be05-468d-aa36-24b016c094f7"},{"name":"Message Image received","id":"bf396e67-6ef4-42ae-a294-203be4f65809","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"VIEW","header":[],"body":{"mode":"raw","raw":"{\n \"version\": 1,\n \"event\": \"message.inbound\",\n \"data\": {\n \"uuid\": \"b78213e075564866807dbd1780eaa09d\",\n \"delivered_datetime\": null,\n \"sent_datetime\": \"2023-05-12T12:59:21+02:00\",\n \"direction\": \"Inbound\",\n \"type\": \"Incoming Message\",\n \"content_type\": \"Image\",\n \"from_phone\": \"{{phone}}\",\n \"is_hidden\": false,\n \"send_status\": \"---\",\n \"send_error_message\": null,\n \"error_code\": null,\n \"error_url\": null,\n \"preview\": {\n \"body\": \"Thanks\"\n },\n \"to_phone\": \"{{to_phone}}\",\n \"text\": \"Thanks\",\n \"timestamp\": 1683889161466,\n \"created_datetime\": \"2023-05-12T10:59:21+00:00\",\n \"locationmessage\": null,\n \"sender\": null,\n \"mediamessage_set\": [\n {\n \"id\": 6881581212,\n \"title\": \"07x825b1-c8b8-4dfc-ac91-x643befe0cx5\",\n \"content_type\": \"image/jpeg\",\n \"media\": \"https://app.spoki.it/md/076825b1-c8b8-4dfc-ac91-3643befe0c25.jpeg?key=bw2b6T5uk64L5mnEvri-bxbn2sbv-xx51kIxTw1o1TU\",\n \"timestamp\": 1700042846907\n }\n ],\n \"contact\": {\n \"id\": 42413,\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"phone\": \"{{phone}}\",\n \"email\": \"john.doe@domain.com\",\n \"language\": \"en\",\n \"has_invalid_phone\": false,\n \"chat_link\": \"https://spoki.app/chats/6490641ba9a049f49f95f1561c9bbe3c\",\n \"created_datetime\": \"2023-03-21T14:16:26.256109+01:00\",\n \"contactfield_set\": [\n {\n \"id\": 292850,\n \"field\": 440,\n \"code\": \"ACCOUNT_NAME\",\n \"visual_code\": \"%%ACCOUNT_NAME%%\",\n \"value\": \"MyShop\",\n \"value_datetime\": null\n }\n ],\n \"contactfield_values\": {\n \"ACCOUNT_NAME\": \"MyShop\"\n },\n \"tag_set\": [],\n \"list_set\": []\n },\n \"metadata\": {\n \"your_str_meta\": \"lorem ipsum\",\n \"your_int_meta\": 3,\n \"your_float_meta\": 42.5,\n \"your_bool_meta\": true\n }\n }\n}","options":{"raw":{"language":"json"}}},"description":"

This event is notified when an image message has been received.

V2 payload

Same structure as Message Text received but with mediamessage_set included by default. contact requires expands.

Available expands: contact, contact.tag_set, contact.list_set, contact.role_set, contact.contactfield_set, contact.contactfield_values

\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"1aaf0d9e-9fd2-4358-b142-dbfcbc21dae1","id":"1aaf0d9e-9fd2-4358-b142-dbfcbc21dae1","name":"Webhooks","type":"folder"}},"urlObject":{"query":[],"variable":[]},"url":""},"response":[],"_postman_id":"bf396e67-6ef4-42ae-a294-203be4f65809"},{"name":"Message Video received","id":"b091c849-6c69-43b1-babb-1494db017624","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"VIEW","header":[],"body":{"mode":"raw","raw":"{\n \"version\": 1,\n \"event\": \"message.inbound\",\n \"data\": {\n \"uuid\": \"b78213e075564866807dbd1780eaa09d\",\n \"delivered_datetime\": null,\n \"sent_datetime\": \"2023-05-12T12:59:21+02:00\",\n \"direction\": \"Inbound\",\n \"type\": \"Incoming Message\",\n \"content_type\": \"Video\",\n \"from_phone\": \"{{phone}}\",\n \"is_hidden\": false,\n \"send_status\": \"---\",\n \"send_error_message\": null,\n \"error_code\": null,\n \"error_url\": null,\n \"preview\": {\n \"body\": \"Thanks\"\n },\n \"to_phone\": \"{{to_phone}}\",\n \"text\": \"Thanks\",\n \"timestamp\": 1683889161466,\n \"created_datetime\": \"2023-05-12T10:59:21+00:00\",\n \"locationmessage\": null,\n \"sender\": null,\n \"mediamessage_set\": [\n {\n \"id\": 688217,\n \"title\": \"ebf9b50f-2c05-4e08-960d-a94214069a57\",\n \"content_type\": \"video/mp4\",\n \"media\": \"https://app.spoki.it/md/ebf9b50f-2c05-4e08-960d-a94214069a57.mp4?key=68iFxF1_ikiWrw6CQSS8wwRA1DkcQ5S3d127vhLNc2A\",\n \"timestamp\": 1700043806831\n }\n ],\n \"contact\": {\n \"id\": 42413,\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"phone\": \"{{phone}}\",\n \"email\": \"john.doe@domain.com\",\n \"language\": \"en\",\n \"has_invalid_phone\": false,\n \"chat_link\": \"https://spoki.app/chats/6490641ba9a049f49f95f1561c9bbe3c\",\n \"created_datetime\": \"2023-03-21T14:16:26.256109+01:00\",\n \"contactfield_set\": [\n {\n \"id\": 292850,\n \"field\": 440,\n \"code\": \"ACCOUNT_NAME\",\n \"visual_code\": \"%%ACCOUNT_NAME%%\",\n \"value\": \"MyShop\",\n \"value_datetime\": null\n }\n ],\n \"contactfield_values\": {\n \"ACCOUNT_NAME\": \"MyShop\"\n },\n \"tag_set\": [],\n \"list_set\": []\n },\n \"metadata\": {\n \"your_str_meta\": \"lorem ipsum\",\n \"your_int_meta\": 3,\n \"your_float_meta\": 42.5,\n \"your_bool_meta\": true\n }\n }\n}","options":{"raw":{"language":"json"}}},"description":"

This event is notified when a video message has been received.

V2 payload

Same as Image received — mediamessage_set included by default with content_type: \"video/mp4\". contact requires expands.

Available expands: contact, contact.tag_set, contact.list_set, contact.role_set, contact.contactfield_set, contact.contactfield_values

\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"1aaf0d9e-9fd2-4358-b142-dbfcbc21dae1","id":"1aaf0d9e-9fd2-4358-b142-dbfcbc21dae1","name":"Webhooks","type":"folder"}},"urlObject":{"query":[],"variable":[]},"url":""},"response":[],"_postman_id":"b091c849-6c69-43b1-babb-1494db017624"},{"name":"Message Audio received","id":"1d3bf445-b616-4e11-a0e8-84fb3c87ed9d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"VIEW","header":[],"body":{"mode":"raw","raw":"{\n \"version\": 1,\n \"event\": \"message.inbound\",\n \"data\": {\n \"uuid\": \"b78213e075564866807dbd1780eaa09d\",\n \"delivered_datetime\": null,\n \"sent_datetime\": \"2023-05-12T12:59:21+02:00\",\n \"direction\": \"Inbound\",\n \"type\": \"Incoming Message\",\n \"content_type\": \"Audio\",\n \"from_phone\": \"{{phone}}\",\n \"is_hidden\": false,\n \"send_status\": \"---\",\n \"send_error_message\": null,\n \"error_code\": null,\n \"error_url\": null,\n \"preview\": {\n \"body\": \"Thanks\"\n },\n \"to_phone\": \"{{to_phone}}\",\n \"text\": \"Thanks\",\n \"timestamp\": 1683889161466,\n \"created_datetime\": \"2023-05-12T10:59:21+00:00\",\n \"locationmessage\": null,\n \"sender\": null,\n \"mediamessage_set\": [\n {\n \"id\": 4882061242332,\n \"title\": \"4d260cx7-58x4-45f9-a2b1-c6c51fdbcd22\",\n \"content_type\": \"audio/ogg; codecs=opus\",\n \"media\": \"https://app.spoki.it/md/4d260c87-58x4-4xf9-a2x1-c6c51fdbcd22.ogg?key=PF-FEfpeuDqWX5EIdc_S9eDzvK3xBPmOCxXiqDmmEUE\",\n \"timestamp\": 1700043629896\n }\n ],\n \"contact\": {\n \"id\": 42413,\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"phone\": \"{{phone}}\",\n \"email\": \"john.doe@domain.com\",\n \"language\": \"en\",\n \"has_invalid_phone\": false,\n \"chat_link\": \"https://spoki.app/chats/6490641ba9a049f49f95f1561c9bbe3c\",\n \"created_datetime\": \"2023-03-21T14:16:26.256109+01:00\",\n \"contactfield_set\": [\n {\n \"id\": 292850,\n \"field\": 440,\n \"code\": \"ACCOUNT_NAME\",\n \"visual_code\": \"%%ACCOUNT_NAME%%\",\n \"value\": \"MyShop\",\n \"value_datetime\": null\n }\n ],\n \"contactfield_values\": {\n \"ACCOUNT_NAME\": \"MyShop\"\n },\n \"tag_set\": [],\n \"list_set\": []\n },\n \"metadata\": {\n \"your_str_meta\": \"lorem ipsum\",\n \"your_int_meta\": 3,\n \"your_float_meta\": 42.5,\n \"your_bool_meta\": true\n }\n }\n}","options":{"raw":{"language":"json"}}},"description":"

This event is notified when an audio message has been received.

V2 payload

Same as Image received — mediamessage_set included by default with content_type: \"audio/ogg\". contact requires expands.

Available expands: contact, contact.tag_set, contact.list_set, contact.role_set, contact.contactfield_set, contact.contactfield_values

\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"1aaf0d9e-9fd2-4358-b142-dbfcbc21dae1","id":"1aaf0d9e-9fd2-4358-b142-dbfcbc21dae1","name":"Webhooks","type":"folder"}},"urlObject":{"query":[],"variable":[]},"url":""},"response":[],"_postman_id":"1d3bf445-b616-4e11-a0e8-84fb3c87ed9d"},{"name":"Message Document received","id":"4358ed29-8ee8-4810-bdb0-80fd34980f43","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"VIEW","header":[],"body":{"mode":"raw","raw":"{\n \"version\": 1,\n \"event\": \"message.inbound\",\n \"data\": {\n \"uuid\": \"b78213e075564866807dbd1780eaa09d\",\n \"delivered_datetime\": null,\n \"sent_datetime\": \"2023-05-12T12:59:21+02:00\",\n \"direction\": \"Inbound\",\n \"type\": \"Incoming Message\",\n \"content_type\": \"Document\",\n \"from_phone\": \"{{phone}}\",\n \"is_hidden\": false,\n \"send_status\": \"---\",\n \"send_error_message\": null,\n \"error_code\": null,\n \"error_url\": null,\n \"preview\": {\n \"body\": \"Thanks\"\n },\n \"to_phone\": \"{{to_phone}}\",\n \"text\": \"Thanks\",\n \"timestamp\": 1683889161466,\n \"created_datetime\": \"2023-05-12T10:59:21+00:00\",\n \"locationmessage\": null,\n \"sender\": null,\n \"mediamessage_set\": [\n {\n \"id\": 1288228532,\n \"title\": \"1a6168x9-8618-4x81-897d-e255xb115e1a\",\n \"content_type\": \"application/pdf\",\n \"media\": \"https://app.spoki.it/md/1a61x859-8x18-4481-8x7d-e2551b115x1a.pdf?key=CyhTx4VJ5cwLqkVUfIgMDmMS7sJVWH_G411xHxM0J_E\",\n \"timestamp\": 1700043849086\n }\n ],\n \"contact\": {\n \"id\": 42413,\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"phone\": \"{{phone}}\",\n \"email\": \"john.doe@domain.com\",\n \"language\": \"en\",\n \"has_invalid_phone\": false,\n \"chat_link\": \"https://spoki.app/chats/6490641ba9a049f49f95f1561c9bbe3c\",\n \"created_datetime\": \"2023-03-21T14:16:26.256109+01:00\",\n \"contactfield_set\": [\n {\n \"id\": 292850,\n \"field\": 440,\n \"code\": \"ACCOUNT_NAME\",\n \"visual_code\": \"%%ACCOUNT_NAME%%\",\n \"value\": \"MyShop\",\n \"value_datetime\": null\n }\n ],\n \"contactfield_values\": {\n \"ACCOUNT_NAME\": \"MyShop\"\n },\n \"tag_set\": [],\n \"list_set\": []\n },\n \"metadata\": {\n \"your_str_meta\": \"lorem ipsum\",\n \"your_int_meta\": 3,\n \"your_float_meta\": 42.5,\n \"your_bool_meta\": true\n }\n }\n}","options":{"raw":{"language":"json"}}},"description":"

This event is notified when a document message has been received.

V2 payload

Same as Image received — mediamessage_set included by default. contact requires expands.

Available expands: contact, contact.tag_set, contact.list_set, contact.role_set, contact.contactfield_set, contact.contactfield_values

\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"1aaf0d9e-9fd2-4358-b142-dbfcbc21dae1","id":"1aaf0d9e-9fd2-4358-b142-dbfcbc21dae1","name":"Webhooks","type":"folder"}},"urlObject":{"query":[],"variable":[]},"url":""},"response":[],"_postman_id":"4358ed29-8ee8-4810-bdb0-80fd34980f43"},{"name":"Message Sticker received","id":"ffac7eb3-8925-4b74-b651-eff41721884a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"VIEW","header":[],"body":{"mode":"raw","raw":"{\n \"version\": 1,\n \"event\": \"message.inbound\",\n \"data\": {\n \"uuid\": \"b78213e075564866807dbd1780eaa09d\",\n \"delivered_datetime\": null,\n \"sent_datetime\": \"2023-05-12T12:59:21+02:00\",\n \"direction\": \"Inbound\",\n \"type\": \"Incoming Message\",\n \"content_type\": \"Sticker\",\n \"from_phone\": \"{{phone}}\",\n \"is_hidden\": false,\n \"send_status\": \"---\",\n \"send_error_message\": null,\n \"error_code\": null,\n \"error_url\": null,\n \"preview\": {\n \"body\": \"Thanks\"\n },\n \"to_phone\": \"{{to_phone}}\",\n \"text\": \"Thanks\",\n \"timestamp\": 1683889161466,\n \"created_datetime\": \"2023-05-12T10:59:21+00:00\",\n \"locationmessage\": null,\n \"sender\": null,\n \"mediamessage_set\": [\n {\n \"id\": 5688220233223,\n \"title\": \"006ffxbe-ffxe-4xaf-9965-65b5c5640dd6\",\n \"content_type\": \"image/webp\",\n \"media\": \"https://app.spoki.it/md/0x6ffxbe-ff9e-49af-9965-65b5cx640dd6.webp?key=3KjxFaCMG6tYp6xyTZTZwYQaARVyOL9kbNsxB6f9LJQ\",\n \"timestamp\": 1700043820707\n }\n ],\n \"contact\": {\n \"id\": 42413,\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"phone\": \"{{phone}}\",\n \"email\": \"john.doe@domain.com\",\n \"language\": \"en\",\n \"has_invalid_phone\": false,\n \"chat_link\": \"https://spoki.app/chats/6490641ba9a049f49f95f1561c9bbe3c\",\n \"created_datetime\": \"2023-03-21T14:16:26.256109+01:00\",\n \"contactfield_set\": [\n {\n \"id\": 292850,\n \"field\": 440,\n \"code\": \"ACCOUNT_NAME\",\n \"visual_code\": \"%%ACCOUNT_NAME%%\",\n \"value\": \"MyShop\",\n \"value_datetime\": null\n }\n ],\n \"contactfield_values\": {\n \"ACCOUNT_NAME\": \"MyShop\"\n },\n \"tag_set\": [],\n \"list_set\": []\n },\n \"metadata\": {\n \"your_str_meta\": \"lorem ipsum\",\n \"your_int_meta\": 3,\n \"your_float_meta\": 42.5,\n \"your_bool_meta\": true\n }\n }\n}","options":{"raw":{"language":"json"}}},"description":"

This event is notified when a sticker message has been received.

V2 payload

Same as Image received — mediamessage_set included by default. contact requires expands.

Available expands: contact, contact.tag_set, contact.list_set, contact.role_set, contact.contactfield_set, contact.contactfield_values

\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"1aaf0d9e-9fd2-4358-b142-dbfcbc21dae1","id":"1aaf0d9e-9fd2-4358-b142-dbfcbc21dae1","name":"Webhooks","type":"folder"}},"urlObject":{"query":[],"variable":[]},"url":""},"response":[],"_postman_id":"ffac7eb3-8925-4b74-b651-eff41721884a"}],"id":"11e90ce0-c505-439b-8299-557d9cdfe398","description":"

This webhook will be triggered by any update of every received message. Therefore, you will receive more than one webhook for the same message.

You can find the message type information in data.content_type. The values of interest to you are: Image, Video, Audio, Document, Sticker.

For your specific use case, you should only consider webhooks with data.mediamessage_set that have elements in the array. You will receive different links for the same media message:

TO IGNORE: The first link is temporary and indicates the content_type provided by WhatsApp (e.g., image / voice / video / sticker / document).
\n
TO CONSIDER: In the second link, you will receive the final media with a detailed content_type (e.g., image/jpeg). You can then consider the webhooks with a valid content type and download it through the link indicated in media.
\n

\n","_postman_id":"11e90ce0-c505-439b-8299-557d9cdfe398","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"1aaf0d9e-9fd2-4358-b142-dbfcbc21dae1","id":"1aaf0d9e-9fd2-4358-b142-dbfcbc21dae1","name":"Webhooks","type":"folder"}}},{"name":"Message sent","id":"5fe73944-0550-4efb-9898-6a89c1cb3359","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"VIEW","header":[],"body":{"mode":"raw","raw":"{\n \"version\": 1,\n \"event\": \"message.outbound\",\n \"data\": {\n \"uuid\": \"8992ce1214744cbfbc0bc1dbf79b3a7e\",\n \"delivered_datetime\": null,\n \"sent_datetime\": null,\n \"direction\": \"Outbound\",\n \"type\": \"Message\",\n \"content_type\": \"Text\",\n \"from_phone\": \"{{from_phone}}\",\n \"is_hidden\": false,\n \"send_status\": \"Delivered\",\n \"send_error_message\": null,\n \"error_code\": null,\n \"error_url\": null,\n \"preview\": {\n \"body\": \"a presto\"\n },\n \"to_phone\": \"{{phone}}\",\n \"text\": \"a presto\",\n \"timestamp\": 1683893130979,\n \"created_datetime\": \"2023-05-12T12:05:30.978568+00:00\",\n \"mediamessage_set\": [],\n \"locationmessage\": null,\n \"sender\": {\n \"id\": 641,\n \"email\": \"jane.doe@mywebsite.com\",\n \"uid\": \"832cb8414e104ef89f3ff7ed1d1ff06a\",\n \"firstname\": \"Jane\",\n \"surname\": \"Doe\",\n \"image\": \"\",\n \"is_service\": false\n },\n \"contactsmessage_set\": [],\n \"contact\": {\n \"id\": 42413,\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"phone\": \"{{phone}}\",\n \"email\": \"john.doe@domain.com\",\n \"language\": \"en\",\n \"has_invalid_phone\": false,\n \"chat_link\": \"https://spoki.app/chats/6490641ba9a049f49f95f1561c9bbe3c\",\n \"created_datetime\": \"2023-03-21T14:16:26.256109+01:00\",\n \"contactfield_set\": [\n {\n \"id\": 292850,\n \"field\": 440,\n \"code\": \"ACCOUNT_NAME\",\n \"visual_code\": \"%%ACCOUNT_NAME%%\",\n \"value\": \"MyShop\",\n \"value_datetime\": null\n }\n ],\n \"contactfield_values\": {\n \"ACCOUNT_NAME\": \"MyShop\"\n },\n \"tag_set\": [],\n \"list_set\": []\n },\n \"metadata\": {\n \"your_str_meta\": \"lorem ipsum\",\n \"your_int_meta\": 3,\n \"your_float_meta\": 42.5,\n \"your_bool_meta\": true\n }\n }\n}","options":{"raw":{"language":"json"}}},"description":"

This event is notified when a message has been sent.

V2 payload

In V2, the contact, sender, and template are not included by default. Request them via the expands API.

V2 includes all inbound message fields plus: sender_id, sender_ref.

Available expands: contact, sender, template, contact.tag_set, contact.list_set, contact.role_set, contact.contactfield_set, contact.contactfield_values

\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"1aaf0d9e-9fd2-4358-b142-dbfcbc21dae1","id":"1aaf0d9e-9fd2-4358-b142-dbfcbc21dae1","name":"Webhooks","type":"folder"}},"urlObject":{"query":[],"variable":[]},"url":""},"response":[],"_postman_id":"5fe73944-0550-4efb-9898-6a89c1cb3359"},{"name":"Note added","id":"721ef7a5-8989-4d8f-b742-0fda81a1d179","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"VIEW","header":[],"body":{"mode":"raw","raw":"{\n \"version\": 1,\n \"event\": \"message.note\",\n \"data\": {\n \"uuid\": \"e85c9fb0ec864b499dc7b4a6a047be5a\",\n \"delivered_datetime\": null,\n \"sent_datetime\": null,\n \"direction\": \"---\",\n \"type\": \"Note\",\n \"content_type\": \"Text\",\n \"from_phone\": null,\n \"is_hidden\": false,\n \"send_status\": \"---\",\n \"send_error_message\": null,\n \"error_code\": null,\n \"error_url\": null,\n \"preview\": {\n \"body\": \"User interested\"\n },\n \"to_phone\": \"+393409525995\",\n \"text\": \"User interested\",\n \"timestamp\": 1683896959614,\n \"created_datetime\": \"2023-05-12T13:09:19.613796+00:00\",\n \"mediamessage_set\": [],\n \"locationmessage\": null,\n \"sender\": {\n \"id\": 641,\n \"email\": \"jane.doe@mywebsite.com\",\n \"uid\": \"832cb8414e104ef89f3ff7ed1d1ff06a\",\n \"firstname\": \"Jane\",\n \"surname\": \"Doe\",\n \"image\": \"\",\n \"is_service\": false\n },\n \"contactsmessage_set\": [],\n \"contact\": {\n \"id\": 42413,\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"phone\": \"{{phone}}\",\n \"email\": \"john.doe@domain.com\",\n \"language\": \"en\",\n \"has_invalid_phone\": false,\n \"chat_link\": \"https://spoki.app/chats/6490641ba9a049f49f95f1561c9bbe3c\",\n \"created_datetime\": \"2023-03-21T14:16:26.256109+01:00\",\n \"contactfield_set\": [\n {\n \"id\": 292850,\n \"field\": 440,\n \"code\": \"ACCOUNT_NAME\",\n \"visual_code\": \"%%ACCOUNT_NAME%%\",\n \"value\": \"MyShop\",\n \"value_datetime\": null\n }\n ],\n \"contactfield_values\": {\n \"ACCOUNT_NAME\": \"MyShop\"\n },\n \"tag_set\": [],\n \"list_set\": []\n },\n \"metadata\": {\n \"your_str_meta\": \"lorem ipsum\",\n \"your_int_meta\": 3,\n \"your_float_meta\": 42.5,\n \"your_bool_meta\": true\n }\n }\n}","options":{"raw":{"language":"json"}}},"description":"

This event is notified when a note has been added to the chat.

V2 payload

In V2, the contact, sender, and template are not included by default. Request them via the expands API.

V2 includes all inbound message fields plus: sender_id, sender_ref.

Available expands: contact, sender, template, contact.tag_set, contact.list_set, contact.role_set, contact.contactfield_set, contact.contactfield_values

\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"1aaf0d9e-9fd2-4358-b142-dbfcbc21dae1","id":"1aaf0d9e-9fd2-4358-b142-dbfcbc21dae1","name":"Webhooks","type":"folder"}},"urlObject":{"query":[],"variable":[]},"url":""},"response":[],"_postman_id":"721ef7a5-8989-4d8f-b742-0fda81a1d179"},{"name":"Chat has unread messages","id":"cbcc0cad-2640-471c-a74d-bc898790a4bf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"VIEW","header":[],"body":{"mode":"raw","raw":"{\n \"version\": 1,\n \"event\": \"chat.has_unread_messages\",\n \"data\": {\n \"uuid\": \"6490641ba9a049f49f95f1561c9bbe3c\",\n \"has_unread_messages\": true,\n \"contact\": {\n \"id\": 42413,\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"phone\": \"{{phone}}\",\n \"email\": \"john.doe@domain.com\",\n \"language\": \"en\",\n \"has_invalid_phone\": false,\n \"chat_link\": \"https://spoki.app/chats/6490641ba9a049f49f95f1561c9bbe3c\",\n \"created_datetime\": \"2023-03-21T14:16:26.256109+01:00\",\n \"contactfield_set\": [\n {\n \"id\": 292850,\n \"field\": 440,\n \"code\": \"ACCOUNT_NAME\",\n \"visual_code\": \"%%ACCOUNT_NAME%%\",\n \"value\": \"MyShop\",\n \"value_datetime\": null\n }\n ],\n \"contactfield_values\": {\n \"ACCOUNT_NAME\": \"MyShop\"\n },\n \"tag_set\": [],\n \"list_set\": []\n }\n }\n}","options":{"raw":{"language":"json"}}},"description":"

This event is notified when a chat has unread messages, or when it has none left. It's the equivalent of the green chat badge shown in Platform.

V2 payload

V2 default: uuid, chat_link, has_unread_messages, unread_count. Full contact object requires expand.

Available expands: contact, contact.tag_set, contact.list_set, contact.role_set, contact.contactfield_set, contact.contactfield_values

V2 Example

{\n    \"version\": 2,\n    \"event\": \"chat.has_unread_messages\",\n    \"event_uuid\": \"6490641b-a9a0-49f4-9f95-f1561c9bbe3c\",\n    \"timestamp\": 1683889000.0,\n    \"data\": {\n        \"uuid\": \"6490641ba9a049f49f95f1561c9bbe3c\",\n        \"chat_link\": \"https://spoki.app/chats/6490641ba9a049f49f95f1561c9bbe3c\",\n        \"has_unread_messages\": true,\n        \"unread_count\": 3\n    }\n}\n

\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"1aaf0d9e-9fd2-4358-b142-dbfcbc21dae1","id":"1aaf0d9e-9fd2-4358-b142-dbfcbc21dae1","name":"Webhooks","type":"folder"}},"urlObject":{"query":[],"variable":[]},"url":""},"response":[],"_postman_id":"cbcc0cad-2640-471c-a74d-bc898790a4bf"},{"name":"Contact created","id":"657efd6d-2030-4df1-92ca-2e1e179c03d5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"VIEW","header":[],"body":{"mode":"raw","raw":"{\n \"version\": 1,\n \"event\": \"contact.created\",\n \"event_uuid\": null,\n \"timestamp\": 1708352661.811551,\n \"data\": {\n \"id\": 43429,\n \"first_name\": \"Mario\",\n \"last_name\": \"Rossi\",\n \"phone\": \"+394563782346\",\n \"email\": null,\n \"has_invalid_phone\": false,\n \"language\": \"it\",\n \"chat_link\": \"https://site-name/chats/7gg7rtgd983h\",\n \"is_restricted\": false\n }\n}","options":{"raw":{"language":"json"}}},"description":"

This event is notified when a contact has been created.

V2 payload

V2 adds ref, status, is_blocked. Nested fields require expands.

Available expands: tag_set, list_set, role_set, contactfield_set, contactfield_values

V2 Example

{\n    \"version\": 2,\n    \"event\": \"contact.created\",\n    \"event_uuid\": \"a1b2c3d4-e5f6-7890-abcd-ef1234567890\",\n    \"timestamp\": 1708352661.811551,\n    \"data\": {\n        \"id\": 43429,\n        \"ref\": \"con_x7k9m2p4\",\n        \"first_name\": \"Mario\",\n        \"last_name\": \"Rossi\",\n        \"phone\": \"+394563782346\",\n        \"email\": null,\n        \"status\": \"Active\",\n        \"has_invalid_phone\": false,\n        \"language\": \"it\",\n        \"chat_link\": \"https://spoki.app/chats/7gg7rtgd983h\",\n        \"created_datetime\": \"2024-02-19T14:24:21+01:00\",\n        \"is_restricted\": false,\n        \"is_blocked\": false\n    }\n}\n

\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"1aaf0d9e-9fd2-4358-b142-dbfcbc21dae1","id":"1aaf0d9e-9fd2-4358-b142-dbfcbc21dae1","name":"Webhooks","type":"folder"}},"urlObject":{"query":[],"variable":[]},"url":""},"response":[],"_postman_id":"657efd6d-2030-4df1-92ca-2e1e179c03d5"},{"name":"Contact updated","id":"4b784b11-b6b3-4f72-b3b4-f041541eca27","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"VIEW","header":[],"body":{"mode":"raw","raw":"{\n \"version\": 1,\n \"event\": \"contact.updated\",\n \"event_uuid\": null,\n \"timestamp\": 1708352661.811551,\n \"data\": {\n \"id\": 43429,\n \"first_name\": \"Mario\",\n \"last_name\": \"Rossi\",\n \"phone\": \"+394563782346\",\n \"email\": null,\n \"has_invalid_phone\": false,\n \"language\": \"it\",\n \"chat_link\": \"https://site-name/chats/7gg7rtgd983h\",\n \"is_restricted\": false\n }\n}","options":{"raw":{"language":"json"}}},"description":"

This event is notified when a contact has been updated.

V2 payload

V2 adds ref, status, is_blocked. Nested fields require expands.

Available expands: tag_set, list_set, role_set, contactfield_set, contactfield_values

V2 Example

{\n    \"version\": 2,\n    \"event\": \"contact.updated\",\n    \"event_uuid\": \"b2c3d4e5-f6a7-8901-bcde-f12345678901\",\n    \"timestamp\": 1708352661.811551,\n    \"data\": {\n        \"id\": 43429,\n        \"ref\": \"con_x7k9m2p4\",\n        \"first_name\": \"Mario\",\n        \"last_name\": \"Rossi\",\n        \"phone\": \"+394563782346\",\n        \"email\": \"mario.rossi@email.it\",\n        \"status\": \"Active\",\n        \"has_invalid_phone\": false,\n        \"language\": \"it\",\n        \"chat_link\": \"https://spoki.app/chats/7gg7rtgd983h\",\n        \"created_datetime\": \"2024-02-19T14:24:21+01:00\",\n        \"is_restricted\": false,\n        \"is_blocked\": false\n    }\n}\n

\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"1aaf0d9e-9fd2-4358-b142-dbfcbc21dae1","id":"1aaf0d9e-9fd2-4358-b142-dbfcbc21dae1","name":"Webhooks","type":"folder"}},"urlObject":{"query":[],"variable":[]},"url":""},"response":[],"_postman_id":"4b784b11-b6b3-4f72-b3b4-f041541eca27"},{"name":"Contact deleted","id":"d1152ba6-ee66-4ecc-a834-8e7413299899","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"VIEW","header":[],"body":{"mode":"raw","raw":"{\n \"version\": 1,\n \"event\": \"contact.deleted\",\n \"event_uuid\": null,\n \"timestamp\": 1708352661.811551,\n \"data\": {\n \"id\": 43429,\n \"first_name\": \"Mario\",\n \"last_name\": \"Rossi\",\n \"phone\": \"+394563782346\",\n \"email\": null,\n \"has_invalid_phone\": false,\n \"language\": \"it\",\n \"chat_link\": \"https://site-name/chats/7gg7rtgd983h\",\n \"is_restricted\": false\n }\n}","options":{"raw":{"language":"json"}}},"description":"

This event is notified when a contact has been deleted.

V2 payload

V2 default includes only id and ref.

V2 Example

{\n    \"version\": 2,\n    \"event\": \"contact.deleted\",\n    \"event_uuid\": \"c3d4e5f6-a7b8-9012-cdef-123456789012\",\n    \"timestamp\": 1708352661.811551,\n    \"data\": {\n        \"id\": 43429,\n        \"ref\": \"con_x7k9m2p4\"\n    }\n}\n

\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"1aaf0d9e-9fd2-4358-b142-dbfcbc21dae1","id":"1aaf0d9e-9fd2-4358-b142-dbfcbc21dae1","name":"Webhooks","type":"folder"}},"urlObject":{"query":[],"variable":[]},"url":""},"response":[],"_postman_id":"d1152ba6-ee66-4ecc-a834-8e7413299899"},{"name":"Contact tag created","id":"e706932c-3d34-4205-8584-371dc4aa3fe8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"VIEW","header":[],"body":{"mode":"raw","raw":"{\n \"version\": 1,\n \"event\": \"contact_tag.created\",\n \"event_uuid\": null,\n \"timestamp\": 1708353164.639808,\n \"data\": {\n \"contact\": {\n \"id\": 42720,\n \"first_name\": \"Mario\",\n \"last_name\": \"Rossi\",\n \"phone\": \"+396754634537\",\n \"email\": \"mario.rossi@mail.it\",\n \"has_invalid_phone\": false,\n \"language\": \"it\",\n \"chat_link\": \"https://site-name/chats/5e8e95d4\",\n \"is_restricted\": false\n },\n \"tag\": {\n \"id\": 2,\n \"name\": \"Bug\",\n \"color\": \"#d4164f\",\n \"order\": 1\n }\n }\n}","options":{"raw":{"language":"json"}}},"description":"

This event is notified when a contact tag has been created.

V2 payload

V2 default: contact_id, contact_ref, tag_id, tag_ref. Full objects require expands.

Available expands: contact, tag, contact.tag_set, contact.list_set, contact.role_set, contact.contactfield_set, contact.contactfield_values

V2 Example

{\n    \"version\": 2,\n    \"event\": \"contact_tag.created\",\n    \"event_uuid\": \"d4e5f6a7-b8c9-0123-def0-234567890123\",\n    \"timestamp\": 1708353164.639808,\n    \"data\": {\n        \"contact_id\": 42720,\n        \"contact_ref\": \"con_m3n4o5p6\",\n        \"tag_id\": 2,\n        \"tag_ref\": \"tag_q7r8s9t0\"\n    }\n}\n

\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"1aaf0d9e-9fd2-4358-b142-dbfcbc21dae1","id":"1aaf0d9e-9fd2-4358-b142-dbfcbc21dae1","name":"Webhooks","type":"folder"}},"urlObject":{"query":[],"variable":[]},"url":""},"response":[],"_postman_id":"e706932c-3d34-4205-8584-371dc4aa3fe8"},{"name":"Contact tag deleted","id":"05c25d75-d244-427d-879f-841760cb9b12","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"VIEW","header":[],"body":{"mode":"raw","raw":"{\n \"version\": 1,\n \"event\": \"contact_tag.deleted\",\n \"event_uuid\": null,\n \"timestamp\": 1708353164.639808,\n \"data\": {\n \"contact\": {\n \"id\": 42720,\n \"first_name\": \"Mario\",\n \"last_name\": \"Rossi\",\n \"phone\": \"+396754634537\",\n \"email\": \"mario.rossi@mail.it\",\n \"has_invalid_phone\": false,\n \"language\": \"it\",\n \"chat_link\": \"https://site-name/chats/5e8e95d4\",\n \"is_restricted\": false\n },\n \"tag\": {\n \"id\": 2,\n \"name\": \"Bug\",\n \"color\": \"#d4164f\",\n \"order\": 1\n }\n }\n}","options":{"raw":{"language":"json"}}},"description":"

This event is notified when a contact tag has been deleted.

V2 payload

V2 default: contact_id, contact_ref, tag_id, tag_ref. Full objects require expands.

Available expands: contact, tag, contact.tag_set, contact.list_set, contact.role_set, contact.contactfield_set, contact.contactfield_values

V2 Example

{\n    \"version\": 2,\n    \"event\": \"contact_tag.deleted\",\n    \"event_uuid\": \"e5f6a7b8-c9d0-1234-ef01-345678901234\",\n    \"timestamp\": 1708353164.639808,\n    \"data\": {\n        \"contact_id\": 42720,\n        \"contact_ref\": \"con_m3n4o5p6\",\n        \"tag_id\": 2,\n        \"tag_ref\": \"tag_q7r8s9t0\"\n    }\n}\n

\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"1aaf0d9e-9fd2-4358-b142-dbfcbc21dae1","id":"1aaf0d9e-9fd2-4358-b142-dbfcbc21dae1","name":"Webhooks","type":"folder"}},"urlObject":{"query":[],"variable":[]},"url":""},"response":[],"_postman_id":"05c25d75-d244-427d-879f-841760cb9b12"},{"name":"Contact list created","id":"90cbcb42-cf5c-45e8-9512-0885405b1bca","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"VIEW","header":[],"body":{"mode":"raw","raw":"{\n \"version\": 1,\n \"event\": \"contact_list.created\",\n \"event_uuid\": null,\n \"timestamp\": 1708353468.752674,\n \"data\": {\n \"contact\": {\n \"id\": 43416,\n \"first_name\": \"Mario\",\n \"last_name\": \"Rossi\",\n \"phone\": \"+393331234567\",\n \"email\": \"mario.rossi@domain.com\",\n \"has_invalid_phone\": false,\n \"language\": \"it\",\n \"chat_link\": \"https://site-name/chats/56894dcb55\",\n \"is_restricted\": false\n },\n \"list\": {\n \"id\": 469,\n \"name\": \"import_sample (30).csv\",\n \"color\": null,\n \"created_datetime\": \"2024-02-19T11:26:36.453079+01:00\",\n \"contacts_count\": 1\n }\n }\n}","options":{"raw":{"language":"json"}}},"description":"

This event is notified when a contact has been added to a list.

V2 payload

V2 default: contact_id, contact_ref, list_id, list_ref. Full objects require expands.

Available expands: contact, list, contact.tag_set, contact.list_set, contact.role_set, contact.contactfield_set, contact.contactfield_values

V2 Example

{\n    \"version\": 2,\n    \"event\": \"contact_list.created\",\n    \"event_uuid\": \"f6a7b8c9-d0e1-2345-f012-456789012345\",\n    \"timestamp\": 1708353468.752674,\n    \"data\": {\n        \"contact_id\": 43416,\n        \"contact_ref\": \"con_u1v2w3x4\",\n        \"list_id\": 469,\n        \"list_ref\": \"lst_y5z6a7b8\"\n    }\n}\n

\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"1aaf0d9e-9fd2-4358-b142-dbfcbc21dae1","id":"1aaf0d9e-9fd2-4358-b142-dbfcbc21dae1","name":"Webhooks","type":"folder"}},"urlObject":{"query":[],"variable":[]},"url":""},"response":[],"_postman_id":"90cbcb42-cf5c-45e8-9512-0885405b1bca"},{"name":"Contact list deleted","id":"697d8e59-8bc5-4776-a265-bd5f3a0ee61d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"VIEW","header":[],"body":{"mode":"raw","raw":"{\n \"version\": 1,\n \"event\": \"contact_list.deleted\",\n \"event_uuid\": null,\n \"timestamp\": 1708353468.752674,\n \"data\": {\n \"contact\": {\n \"id\": 43416,\n \"first_name\": \"Mario\",\n \"last_name\": \"Rossi\",\n \"phone\": \"+393331234567\",\n \"email\": \"mario.rossi@domain.com\",\n \"has_invalid_phone\": false,\n \"language\": \"it\",\n \"chat_link\": \"https://site-name/chats/56894dcb55\",\n \"is_restricted\": false\n },\n \"list\": {\n \"id\": 469,\n \"name\": \"import_sample (30).csv\",\n \"color\": null,\n \"created_datetime\": \"2024-02-19T11:26:36.453079+01:00\",\n \"contacts_count\": 1\n }\n }\n}","options":{"raw":{"language":"json"}}},"description":"

This event is notified when a contact has been removed from a list.

V2 payload

V2 default: contact_id, contact_ref, list_id, list_ref. Full objects require expands.

Available expands: contact, list, contact.tag_set, contact.list_set, contact.role_set, contact.contactfield_set, contact.contactfield_values

V2 Example

{\n    \"version\": 2,\n    \"event\": \"contact_list.deleted\",\n    \"event_uuid\": \"a7b8c9d0-e1f2-3456-0123-567890123456\",\n    \"timestamp\": 1708353468.752674,\n    \"data\": {\n        \"contact_id\": 43416,\n        \"contact_ref\": \"con_u1v2w3x4\",\n        \"list_id\": 469,\n        \"list_ref\": \"lst_y5z6a7b8\"\n    }\n}\n

\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"1aaf0d9e-9fd2-4358-b142-dbfcbc21dae1","id":"1aaf0d9e-9fd2-4358-b142-dbfcbc21dae1","name":"Webhooks","type":"folder"}},"urlObject":{"query":[],"variable":[]},"url":""},"response":[],"_postman_id":"697d8e59-8bc5-4776-a265-bd5f3a0ee61d"},{"name":"Contact field created or updated","id":"063392f8-7f23-4272-91c0-0f9b8de473eb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"VIEW","header":[],"body":{"mode":"raw","raw":"{\n \"version\": 1,\n \"event\": \"contact_field.created_or_updated\",\n \"event_uuid\": null,\n \"timestamp\": 1708353779.160536,\n \"data\": {\n \"contact\": {\n \"id\": 43421,\n \"first_name\": \"Mario\",\n \"last_name\": \"Rossi\",\n \"phone\": \"+394767456321\",\n \"email\": null,\n \"has_invalid_phone\": false,\n \"language\": \"it\",\n \"chat_link\": \"https://site-name/chats/12608f8468ac\",\n \"is_restricted\": false\n },\n \"contact_field\": {\n \"id\": 293013,\n \"field\": 116,\n \"code\": \"ZABAIONE\",\n \"visual_code\": \"%%ZABAIONE%%\",\n \"value\": \"this is a test message\",\n \"value_datetime\": null\n }\n }\n}","options":{"raw":{"language":"json"}}},"description":"

This event is notified when a contact field has been created or updated.

V2 payload

V2 default: contact_id, contact_ref, contact_field (nested object with ref, field_ref, code, visual_code, value, value_datetime). Full contact object requires expand.

Available expands: contact, contact.tag_set, contact.list_set, contact.role_set, contact.contactfield_set, contact.contactfield_values

V2 Example

{\n    \"version\": 2,\n    \"event\": \"contact_field.created_or_updated\",\n    \"event_uuid\": \"b8c9d0e1-f2a3-4567-1234-678901234567\",\n    \"timestamp\": 1708353779.160536,\n    \"data\": {\n        \"contact_id\": 43421,\n        \"contact_ref\": \"con_c9d0e1f2\",\n        \"contact_field\": {\n            \"ref\": \"cfld_a1b2c3d4\",\n            \"field_ref\": \"fld_g3h4i5j6\",\n            \"code\": \"CITY\",\n            \"visual_code\": \"%%CITY%%\",\n            \"value\": \"Milano\",\n            \"value_datetime\": null\n        }\n    }\n}\n

\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"1aaf0d9e-9fd2-4358-b142-dbfcbc21dae1","id":"1aaf0d9e-9fd2-4358-b142-dbfcbc21dae1","name":"Webhooks","type":"folder"}},"urlObject":{"query":[],"variable":[]},"url":""},"response":[],"_postman_id":"063392f8-7f23-4272-91c0-0f9b8de473eb"},{"name":"Contact field deleted","id":"52b197e4-4dcd-4aad-802a-6e4e6853a1e5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"VIEW","header":[],"body":{"mode":"raw","raw":"{\n \"version\": 1,\n \"event\": \"contact_field.deleted\",\n \"event_uuid\": null,\n \"timestamp\": 1708353779.160536,\n \"data\": {\n \"contact\": {\n \"id\": 43421,\n \"first_name\": \"Mario\",\n \"last_name\": \"Rossi\",\n \"phone\": \"+394767456321\",\n \"email\": null,\n \"has_invalid_phone\": false,\n \"language\": \"it\",\n \"chat_link\": \"https://site-name/chats/12608f8468ac\",\n \"is_restricted\": false\n },\n \"contact_field\": {\n \"id\": 293013,\n \"field\": 116,\n \"code\": \"ZABAIONE\",\n \"visual_code\": \"%%ZABAIONE%%\",\n \"value\": \"this is a test message\",\n \"value_datetime\": null\n }\n }\n}","options":{"raw":{"language":"json"}}},"description":"

This event is notified when a contact field has been deleted.

V2 payload

V2 default: contact_id, contact_ref, contact_field (nested object with ref, field_ref, code, visual_code, value, value_datetime). Full contact object requires expand.

Available expands: contact, contact.tag_set, contact.list_set, contact.role_set, contact.contactfield_set, contact.contactfield_values

V2 Example

{\n    \"version\": 2,\n    \"event\": \"contact_field.deleted\",\n    \"event_uuid\": \"c9d0e1f2-a3b4-5678-2345-789012345678\",\n    \"timestamp\": 1708353779.160536,\n    \"data\": {\n        \"contact_id\": 43421,\n        \"contact_ref\": \"con_c9d0e1f2\",\n        \"contact_field\": {\n            \"ref\": \"cfld_a1b2c3d4\",\n            \"field_ref\": \"fld_g3h4i5j6\",\n            \"code\": \"CITY\",\n            \"visual_code\": \"%%CITY%%\",\n            \"value\": \"Milano\",\n            \"value_datetime\": null\n        }\n    }\n}\n

\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"1aaf0d9e-9fd2-4358-b142-dbfcbc21dae1","id":"1aaf0d9e-9fd2-4358-b142-dbfcbc21dae1","name":"Webhooks","type":"folder"}},"urlObject":{"query":[],"variable":[]},"url":""},"response":[],"_postman_id":"52b197e4-4dcd-4aad-802a-6e4e6853a1e5"},{"name":"Form filled","id":"9d2bc554-901d-4164-b062-20e66e4ead92","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"VIEW","header":[],"body":{"mode":"raw","raw":"{\n \"version\": 1,\n \"event\": \"form_answer.submitted\",\n \"event_uuid\": \"de87becb-9230-4956-a068-b651a3199707\",\n \"timestamp\": 1758640115.678934,\n \"data\": {\n \"version\": 1,\n \"event\": \"form_answer.submitted\",\n \"event_uuid\": \"7720237a-f608-4a02-a857-7e8bbf6c6d4e\",\n \"timestamp\": 1746018902.049365,\n \"data\": {\n \"id\": \"64fb688675b34da5937d2f6da2113dc7\",\n \"form\": {\n \"id\": \"d91eb5363adb4a4ab10826fbb9a8293b\",\n \"name\": \"Lead Generation\"\n },\n \"contact\": {\n \"id\": 1234567890,\n \"phone\": \"+393409525995\",\n \"email\": \"ds@dd.it\",\n \"first_name\": \"Mario\",\n \"last_name\": \"Rossi\",\n \"full_name\": \"Mario Rossi\"\n },\n \"response_data\": {\n \"email\": \"mario.rossi@example.it\",\n \"form_id\": \"d91eb5363adb4a4ab10826fbsssss293b\",\n \"last_name\": \"Rossi\",\n \"first_name\": \"Mario\",\n \"flow_token\": \"unused\"\n },\n \"completed_screens\": [],\n \"is_completed\": true,\n \"attributes\": null,\n \"created_datetime\": \"2025-04-30T15:15:02.029299+02:00\",\n \"updated_datetime\": \"2025-04-30T15:15:02.029310+02:00\",\n \"extracted_fields\": {}\n }\n }\n}","options":{"raw":{"language":"json"}}},"description":"

This event is notified when a form answer has been submitted.

V2 payload

V2 default: id, ref, form_id, form_ref, contact_id, contact_ref, source, platform. All nested objects require expands.

Available expands: form, contact, response_data, completed_screens, attributes, extracted_fields, contact.tag_set, contact.list_set, contact.contactfield_set, contact.contactfield_values

V2 Example

{\n    \"version\": 2,\n    \"event\": \"form_answer.submitted\",\n    \"event_uuid\": \"de87becb-9230-4956-a068-b651a3199707\",\n    \"timestamp\": 1758640115.678934,\n    \"data\": {\n        \"id\": \"64fb688675b34da5937d2f6da2113dc7\",\n        \"ref\": \"fa_k7l8m9n0\",\n        \"form_id\": \"d91eb5363adb4a4ab10826fbb9a8293b\",\n        \"form_ref\": \"frm_p1q2r3s4\",\n        \"contact_id\": 1234567890,\n        \"contact_ref\": \"con_t5u6v7w8\",\n        \"source\": \"whatsapp\",\n        \"platform\": \"flows\"\n    }\n}\n

\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"1aaf0d9e-9fd2-4358-b142-dbfcbc21dae1","id":"1aaf0d9e-9fd2-4358-b142-dbfcbc21dae1","name":"Webhooks","type":"folder"}},"urlObject":{"query":[],"variable":[]},"url":""},"response":[],"_postman_id":"9d2bc554-901d-4164-b062-20e66e4ead92"},{"name":"Template created","id":"184deda4-c32d-4162-bb25-e3dd58eecb68","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"VIEW","header":[],"body":{"mode":"raw","raw":"{\n \"version\": 1,\n \"event\": \"template.created\",\n \"event_uuid\": \"2b71ebf7-3f00-4b12-9ca2-543974eef630\",\n \"timestamp\": 1758640330.036732,\n \"data\": {\n \"id\": 45678,\n \"name\": \"Lorem Ipsum\",\n \"category\": \"MARKETING\",\n \"subcategory\": \"CLASSIC\",\n \"integration\": -1,\n \"is_approved\": false,\n \"is_favorite\": false,\n \"customfield_set\": [\n \"%%FIRST_NAME%%\"\n ],\n \"templatelocalization_set\": [\n {\n \"language\": \"it\",\n \"status\": \"DRAFT\",\n \"rejection_reason\": null,\n \"header\": null,\n \"body\": {\n \"component_type\": \"body\",\n \"format\": null,\n \"text\": \"Ciao %%FIRST_NAME%%! 🌟 Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nullam nec ante vel ante finibus finibus. Nullam nec ante vel ante finibus finibus. Nullam nec ante vel ante finibus finibus.\"\n },\n \"footer\": null,\n \"button_set\": [\n {\n \"order\": 0,\n \"button_type\": \"unsubscribe\",\n \"text\": \"Disiscriviti\",\n \"phone_number\": null,\n \"url\": null,\n \"form_id\": null\n }\n ],\n \"carouselcomponent_set\": [],\n \"default_header_media\": null\n }\n ],\n \"template_groups\": []\n }\n}","options":{"raw":{"language":"json"}}},"description":"

This event is notified when a template has been created.

V2 payload

Template events are an exception — in V2, the nested fields (templatelocalization_set, template_groups, customfield_set) are always included without requiring expands. No expands are needed or available for this event type.

\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"1aaf0d9e-9fd2-4358-b142-dbfcbc21dae1","id":"1aaf0d9e-9fd2-4358-b142-dbfcbc21dae1","name":"Webhooks","type":"folder"}},"urlObject":{"query":[],"variable":[]},"url":""},"response":[],"_postman_id":"184deda4-c32d-4162-bb25-e3dd58eecb68"},{"name":"Template updated","id":"d5bf72d6-be22-4740-b532-90498a2b3476","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"VIEW","header":[],"body":{"mode":"raw","raw":"{\n \"version\": 1,\n \"event\": \"template.updated\",\n \"event_uuid\": \"ae8b25b0-05fb-4ec0-9f92-239be7f20e9c\",\n \"timestamp\": 1758640386.190504,\n \"data\": {\n \"id\": 45678,\n \"name\": \"Lorem Ipsum\",\n \"category\": \"MARKETING\",\n \"subcategory\": \"CLASSIC\",\n \"integration\": -1,\n \"is_approved\": false,\n \"is_favorite\": false,\n \"customfield_set\": [\n \"%%FIRST_NAME%%\"\n ],\n \"templatelocalization_set\": [\n {\n \"language\": \"it\",\n \"status\": \"DRAFT\",\n \"rejection_reason\": null,\n \"header\": null,\n \"body\": {\n \"component_type\": \"body\",\n \"format\": null,\n \"text\": \"Ciao %%FIRST_NAME%%! 🌟 Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nullam nec ante vel ante finibus finibus. Nullam nec ante vel ante finibus finibus. Nullam nec ante vel ante finibus finibus.\"\n },\n \"footer\": null,\n \"button_set\": [\n {\n \"order\": 0,\n \"button_type\": \"unsubscribe\",\n \"text\": \"Disiscriviti\",\n \"phone_number\": null,\n \"url\": null,\n \"form_id\": null\n }\n ],\n \"carouselcomponent_set\": [],\n \"default_header_media\": null\n }\n ],\n \"template_groups\": []\n }\n}","options":{"raw":{"language":"json"}}},"description":"

This event is notified when a template has been updated.

V2 payload

\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"1aaf0d9e-9fd2-4358-b142-dbfcbc21dae1","id":"1aaf0d9e-9fd2-4358-b142-dbfcbc21dae1","name":"Webhooks","type":"folder"}},"urlObject":{"query":[],"variable":[]},"url":""},"response":[],"_postman_id":"d5bf72d6-be22-4740-b532-90498a2b3476"},{"name":"Template deleted","id":"282a343e-501f-4aaa-95bc-e6cb74353d02","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"VIEW","header":[],"body":{"mode":"raw","raw":"{\n \"version\": 1,\n \"event\": \"template.deleted\",\n \"event_uuid\": \"a56799ae-a606-4904-aee1-04ed688aed31\",\n \"timestamp\": 1758640505.536392,\n \"data\": {\n \"id\": 2337\n }\n}","options":{"raw":{"language":"json"}}},"description":"

This event is notified when a template has been deleted.

V2 payload

Template events are an exception — in V2, the nested fields are always included without requiring expands. For deletion, only the id and ref are sent. No expands are needed or available for this event type.

\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"1aaf0d9e-9fd2-4358-b142-dbfcbc21dae1","id":"1aaf0d9e-9fd2-4358-b142-dbfcbc21dae1","name":"Webhooks","type":"folder"}},"urlObject":{"query":[],"variable":[]},"url":""},"response":[],"_postman_id":"282a343e-501f-4aaa-95bc-e6cb74353d02"},{"name":"Whatsapp channel status","id":"1a017348-8ff2-465a-bd53-0137f1ebe2e7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"VIEW","header":[],"body":{"mode":"raw","raw":"{\n \"version\": 1,\n \"event\": \"channel.whatsapp.status\",\n \"event_uuid\": \"5a973c07-a8a8-45c7-afd4-dd57460c8a62\",\n \"timestamp\": 1758640650.27122,\n \"data\": {\n \"account_id\": 9968,\n \"phone\": \"390831981810\",\n \"is_enabled\": true,\n \"is_active\": true,\n \"phone_status\": \"Connected\",\n \"quality_score\": \"Green\",\n \"quality_reasons\": \"\"\n }\n}","options":{"raw":{"language":"json"}}},"description":"

This event is notified when the WhatsApp channel status changes.

V2 payload

Channel status events have the same payload in V1 and V2. No expands are available for this event type.

\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"1aaf0d9e-9fd2-4358-b142-dbfcbc21dae1","id":"1aaf0d9e-9fd2-4358-b142-dbfcbc21dae1","name":"Webhooks","type":"folder"}},"urlObject":{"query":[],"variable":[]},"url":""},"response":[],"_postman_id":"1a017348-8ff2-465a-bd53-0137f1ebe2e7"},{"name":"SMS One-way channel status","id":"18a624ca-54f1-403c-82f0-0d18a8e68312","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"VIEW","header":[],"body":{"mode":"raw","raw":"{\n \"version\": 1,\n \"event\": \"channel.sms_one_way.status\",\n \"event_uuid\": \"0cdab304-c9c2-45bd-b09e-2145b5e46c8d\",\n \"timestamp\": 1758640742.426857,\n \"data\": {\n \"account_id\": 9968,\n \"phone\": \"390831981810\",\n \"is_enabled\": true,\n \"is_active\": false\n }\n}","options":{"raw":{"language":"json"}}},"description":"

This event is notified when the SMS One-way channel status changes.

V2 payload

Channel status events have the same payload in V1 and V2. No expands are available for this event type.

\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"1aaf0d9e-9fd2-4358-b142-dbfcbc21dae1","id":"1aaf0d9e-9fd2-4358-b142-dbfcbc21dae1","name":"Webhooks","type":"folder"}},"urlObject":{"query":[],"variable":[]},"url":""},"response":[],"_postman_id":"18a624ca-54f1-403c-82f0-0d18a8e68312"},{"name":"SMS Two-way channel status","id":"9e51841c-9947-4ec3-b5df-000b31c0a8f5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"VIEW","header":[],"body":{"mode":"raw","raw":"{\n \"version\": 1,\n \"event\": \"channel.sms_two_way.status\",\n \"event_uuid\": \"d91f9b45-5b02-45a2-ba44-0018d0fb4936\",\n \"timestamp\": 1758640775.731556,\n \"data\": {\n \"account_id\": 9968,\n \"phone\": \"390831981810\",\n \"is_enabled\": true,\n \"is_active\": false\n }\n}","options":{"raw":{"language":"json"}}},"description":"

This event is notified when the SMS Two-way channel status changes.

V2 payload

Channel status events have the same payload in V1 and V2. No expands are available for this event type.

\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"1aaf0d9e-9fd2-4358-b142-dbfcbc21dae1","id":"1aaf0d9e-9fd2-4358-b142-dbfcbc21dae1","name":"Webhooks","type":"folder"}},"urlObject":{"query":[],"variable":[]},"url":""},"response":[],"_postman_id":"9e51841c-9947-4ec3-b5df-000b31c0a8f5"},{"name":"Account Violation","id":"a4fdbb77-a551-48c2-868f-ae234ec68140","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"VIEW","header":[],"body":{"mode":"raw","raw":"{\n \"version\": 1,\n \"event\": \"channel.whatsapp.violation\",\n \"event_uuid\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"timestamp\": 1708353164.639808,\n \"data\": {\n \"account_id\": 123,\n \"violation\": {\n \"type\": \"SPAM\",\n \"event_id\": \"817884dd-fecd-4442-80fd-6b25d7cf302f\",\n \"property\": \"ACCOUNT_VIOLATION\",\n \"timestamp\": \"2025-12-02T16:05:49.741335+00:00\",\n \"waba_name\": \"Test name\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"description":"

This event is notified when an account violation is detected.

V2 payload

Account violation events have the same payload in V1 and V2. No expands are available for this event type.

\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"1aaf0d9e-9fd2-4358-b142-dbfcbc21dae1","id":"1aaf0d9e-9fd2-4358-b142-dbfcbc21dae1","name":"Webhooks","type":"folder"}},"urlObject":{"query":[],"variable":[]},"url":""},"response":[],"_postman_id":"a4fdbb77-a551-48c2-868f-ae234ec68140"},{"name":"Account Restriction","id":"17b040c1-a4a1-44f3-afc5-cbcb5cb2836d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"VIEW","header":[],"body":{"mode":"raw","raw":"{\n \"version\": 1,\n \"event\": \"channel.whatsapp.restriction\",\n \"event_uuid\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"timestamp\": 1708353164.639808,\n \"data\": {\n \"account_id\": 123,\n \"restrictions\": [\n {\n \"expiration\": \"2026-01-01T16:05:32+0000\",\n \"restrictionType\": \"RESTRICTED_ADD_PHONE_NUMBER_ACTION\"\n },\n {\n \"expiration\": \"2026-01-01T16:05:32+0000\",\n \"restrictionType\": \"RESTRICTED_BIZ_INITIATED_MESSAGING\"\n },\n {\n \"expiration\": \"2026-01-01T16:05:32+0000\",\n \"restrictionType\": \"RESTRICTED_CUSTOMER_INITIATED_MESSAGING\"\n }\n ]\n }\n}","options":{"raw":{"language":"json"}}},"description":"

This event is notified when an account restriction is applied.

V2 payload

Account restriction events have the same payload in V1 and V2. No expands are available for this event type.

\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"1aaf0d9e-9fd2-4358-b142-dbfcbc21dae1","id":"1aaf0d9e-9fd2-4358-b142-dbfcbc21dae1","name":"Webhooks","type":"folder"}},"urlObject":{"query":[],"variable":[]},"url":""},"response":[],"_postman_id":"17b040c1-a4a1-44f3-afc5-cbcb5cb2836d"},{"name":"Account Tier Changed","id":"7e7df60c-c775-412e-9ad1-b32f10fa1ac5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"VIEW","header":[],"body":{"mode":"raw","raw":"{\n \"version\": 1,\n \"event\": \"channel.whatsapp.tier_changed\",\n \"event_uuid\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"timestamp\": 1708353164.639808,\n \"data\": {\n \"account_id\": 123,\n \"phone\": \"+393331234567\",\n \"daily_limit\": 100000,\n \"previous_daily_limit\": 10000\n }\n}","options":{"raw":{"language":"json"}}},"description":"

This event is notified when the account messaging tier changes.

V2 payload

Account tier changed events have the same payload in V1 and V2. No expands are available for this event type.

\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"1aaf0d9e-9fd2-4358-b142-dbfcbc21dae1","id":"1aaf0d9e-9fd2-4358-b142-dbfcbc21dae1","name":"Webhooks","type":"folder"}},"urlObject":{"query":[],"variable":[]},"url":""},"response":[],"_postman_id":"7e7df60c-c775-412e-9ad1-b32f10fa1ac5"},{"name":"Campaign created","id":"bbf1a213-a756-4e71-9c45-8b73452e6882","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"VIEW","header":[],"body":{"mode":"raw","raw":"{\n \"version\": 1,\n \"event\": \"campaign.created\",\n \"event_uuid\": \"365cd5f1-18e0-4271-b019-cda8deedd1c1e\",\n \"timestamp\": 1773242105.131103,\n \"data\": {\n \"id\": 123,\n \"name\": \"example campaign\",\n \"status\": \"Scheduled\",\n \"campaign_type\": \"Scheduled\",\n \"scheduled_datetime\": \"2026-03-11T15:16:00.058000+00:00\",\n \"start_datetime\": null,\n \"end_datetime\": null,\n \"created_datetime\": \"2026-03-11T15:15:05.117370+00:00\"\n }\n}","options":{"raw":{"language":"json"}}},"description":"

This event is notified when a campaign has been created.

V2 payload

Campaign events have the same payload in V1 and V2. No expands are available for this event type.

\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"1aaf0d9e-9fd2-4358-b142-dbfcbc21dae1","id":"1aaf0d9e-9fd2-4358-b142-dbfcbc21dae1","name":"Webhooks","type":"folder"}},"urlObject":{"query":[],"variable":[]},"url":""},"response":[],"_postman_id":"bbf1a213-a756-4e71-9c45-8b73452e6882"},{"name":"Campaign deleted","id":"c9a5f59f-0025-4b10-a928-c9a2ca999f32","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"VIEW","header":[],"body":{"mode":"raw","raw":"{\n \"version\": 1,\n \"event\": \"campaign.created\",\n \"event_uuid\": \"365cd5f1-18e0-4271-b019-cda8deedd1c1e\",\n \"timestamp\": 1773242105.131103,\n \"data\": {\n \"id\": 123,\n \"name\": \"example campaign\",\n \"status\": \"Scheduled\",\n \"campaign_type\": \"Scheduled\",\n \"scheduled_datetime\": \"2026-03-11T15:16:00.058000+00:00\",\n \"start_datetime\": null,\n \"end_datetime\": null,\n \"created_datetime\": \"2026-03-11T15:15:05.117370+00:00\"\n }\n}","options":{"raw":{"language":"json"}}},"description":"

This event is notified when a campaign has been deleted.

V2 payload

Campaign events have the same payload in V1 and V2. No expands are available for this event type.

\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"1aaf0d9e-9fd2-4358-b142-dbfcbc21dae1","id":"1aaf0d9e-9fd2-4358-b142-dbfcbc21dae1","name":"Webhooks","type":"folder"}},"urlObject":{"query":[],"variable":[]},"url":""},"response":[],"_postman_id":"c9a5f59f-0025-4b10-a928-c9a2ca999f32"},{"name":"Campaign status changed","id":"1f23f1d2-6505-4816-bf3b-0c1692515ac2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"VIEW","header":[],"body":{"mode":"raw","raw":"{\n \"version\": 1,\n \"event\": \"campaign.status_changed\",\n \"event_uuid\": \"3e75fafb-xxxx-xxxx-a93e-89cf4c88afdf\",\n \"timestamp\": 1773242144.625431,\n \"data\": {\n \"id\": 123,\n \"name\": \"example campaign\",\n \"old_status\": \"Scheduled\",\n \"new_status\": \"Processing\",\n \"campaign_type\": \"Scheduled\",\n \"scheduled_datetime\": \"2026-03-11T15:16:00.058000+00:00\",\n \"start_datetime\": \"2026-03-11T15:15:44.272751+00:00\",\n \"end_datetime\": null,\n \"created_datetime\": \"2026-03-11T15:15:05.117370+00:00\"\n }\n}","options":{"raw":{"language":"json"}}},"description":"

This event is notified when a campaign status changes (e.g. started, completed, paused).

V2 payload

Campaign events have the same payload in V1 and V2. No expands are available for this event type.

\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"1aaf0d9e-9fd2-4358-b142-dbfcbc21dae1","id":"1aaf0d9e-9fd2-4358-b142-dbfcbc21dae1","name":"Webhooks","type":"folder"}},"urlObject":{"query":[],"variable":[]},"url":""},"response":[],"_postman_id":"1f23f1d2-6505-4816-bf3b-0c1692515ac2"},{"name":"Channel Activation","id":"c712dba4-57e6-41f8-8cc1-159dc4d9e7d3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"VIEW","header":[],"body":{"mode":"raw","raw":"{\n \"version\": 1,\n \"event\": \"channel.activation\",\n \"event_uuid\": \"a1b2c3d4-e5f6-7890-abcd-ef1234567890\",\n \"timestamp\": 1710000000.0,\n \"data\": {\n \"account_id\": 123,\n \"action_type\": \"activation_started\",\n \"phone\": \"+15555555555\",\n \"account_name\": \"My Business\",\n \"user\": \"user@example.com\",\n \"metadata\": {}\n }\n}","options":{"raw":{"language":"json"}}},"description":"

This event is notified during the channel activation process (onboarding steps).

V2 payload

Channel activation events have the same payload in V1 and V2. No expands are available for this event type.

\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"1aaf0d9e-9fd2-4358-b142-dbfcbc21dae1","id":"1aaf0d9e-9fd2-4358-b142-dbfcbc21dae1","name":"Webhooks","type":"folder"}},"urlObject":{"query":[],"variable":[]},"url":""},"response":[],"_postman_id":"c712dba4-57e6-41f8-8cc1-159dc4d9e7d3"}],"id":"cdd3cba2-4345-476d-a3c0-d7ab6689a2ff","description":"

The webhooks body content represents the structured payload that Spoki sends to your endpoint whenever an external webhook event is triggered. It contains the contextual data of the event, organized by type (e.g., message received, delivery updates, status changes).

All webhook payloads share these top-level fields:

version (integer) – The webhook schema version (currently 1).
\n
event (string) – The type of event that triggered the webhook (e.g., message.received, channel.whatsapp.status).
\n
event_uuid (string, UUID) – A unique identifier for the webhook event, useful for idempotency and tracing.
\n
timestamp (float) – The time the event occurred, expressed as a Unix timestamp in seconds.
\n
data (object) – An object containing the event-specific payload. Its structure varies depending on the event type.
\n

This body allows your system to parse and respond programmatically to events coming from Spoki, ensuring proper handling of user interactions and message flows.

\n","_postman_id":"cdd3cba2-4345-476d-a3c0-d7ab6689a2ff","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"1aaf0d9e-9fd2-4358-b142-dbfcbc21dae1","id":"1aaf0d9e-9fd2-4358-b142-dbfcbc21dae1","name":"Webhooks","type":"folder"}}},{"name":"Signature Verification","id":"90e16d10-0213-035d-45a2-1e39550ca4ce","request":{"method":"VIEW","header":[],"description":"

Every webhook delivery includes a signature header so you can verify that the request was sent by Spoki and not a third party.

V2 Signature

V2 webhooks use HMAC-SHA256. The signature is sent in the X-Spoki-Signature header:

X-Spoki-Signature: t=1683889161,v2=5257a869e7ecebeda32affa62cdca3fa51cad7e77a0e56ff536d0ce8e108d8f9\n\n

How to verify

Extract the t (timestamp) and v2 (signature) values from the header
\n
Build the signed payload: {timestamp}.{raw_json_body}
\n
Compute HMAC-SHA256 using your webhook secret (whsec_...) as the key
\n
Compare the computed signature with the v2 value
\n
(Optional) Check that t is within an acceptable time window (e.g. 5 minutes) to prevent replay attacks
\n

Python

import hmac\nimport hashlib\nimport time\ndef verify_v2_signature(payload: bytes, header: str, secret: str, tolerance: int = 300) -> bool:\n    parts = dict(p.split(\"=\", 1) for p in header.split(\",\"))\n    timestamp = parts[\"t\"]\n    signature = parts[\"v2\"]\n    signed_payload = f\"{timestamp}.{payload.decode()}\"\n    expected = hmac.new(secret.encode(), signed_payload.encode(), hashlib.sha256).hexdigest()\n    if not hmac.compare_digest(expected, signature):\n        return False\n    if abs(time.time() - int(timestamp)) > tolerance:\n        return False\n    return True\n\n

Node.js

const crypto = require(\"crypto\");\nfunction verifyV2Signature(payload, header, secret, tolerance = 300) {\n    const parts = Object.fromEntries(header.split(\",\").map(p => p.split(\"=\", 2)));\n    const { t: timestamp, v2: signature } = parts;\n    const signedPayload = `${timestamp}.${payload}`;\n    const expected = crypto.createHmac(\"sha256\", secret).update(signedPayload).digest(\"hex\");\n    if (!crypto.timingSafeEqual(Buffer.from(expected), Buffer.from(signature))) {\n        return false;\n    }\n    if (Math.abs(Date.now() / 1000 - parseInt(timestamp)) > tolerance) {\n        return false;\n    }\n    return true;\n}\n\n

PHP

function verifyV2Signature(string $payload, string $header, string $secret, int $tolerance = 300): bool {\n    $parts = [];\n    foreach (explode(\",\", $header) as $part) {\n        [$key, $value] = explode(\"=\", $part, 2);\n        $parts[$key] = $value;\n    }\n    $signedPayload = $parts[\"t\"] . \".\" . $payload;\n    $expected = hash_hmac(\"sha256\", $signedPayload, $secret);\n    if (!hash_equals($expected, $parts[\"v2\"])) {\n        return false;\n    }\n    if (abs(time() - intval($parts[\"t\"])) > $tolerance) {\n        return false;\n    }\n    return true;\n}\n\n

Go

import (\n    \"crypto/hmac\"\n    \"crypto/sha256\"\n    \"encoding/hex\"\n    \"fmt\"\n    \"math\"\n    \"strconv\"\n    \"strings\"\n    \"time\"\n)\nfunc VerifyV2Signature(payload, header, secret string, tolerance int64) bool {\n    parts := make(map[string]string)\n    for _, p := range strings.Split(header, \",\") {\n        kv := strings.SplitN(p, \"=\", 2)\n        parts[kv[0]] = kv[1]\n    }\n    signedPayload := fmt.Sprintf(\"%s.%s\", parts[\"t\"], payload)\n    mac := hmac.New(sha256.New, []byte(secret))\n    mac.Write([]byte(signedPayload))\n    expected := hex.EncodeToString(mac.Sum(nil))\n    if !hmac.Equal([]byte(expected), []byte(parts[\"v2\"])) {\n        return false\n    }\n    ts, _ := strconv.ParseInt(parts[\"t\"], 10, 64)\n    if math.Abs(float64(time.Now().Unix()-ts)) > float64(tolerance) {\n        return false\n    }\n    return true\n}\n\n

V1 Signature (Deprecated)

V1 webhooks use PBKDF2-HMAC-SHA256 with 200,000 iterations. The signature is sent in the X-SPOKI-HASH header:

X-SPOKI-HASH: a1b2c3d4e5f6...\n\n

How to verify (Python)

import hashlib\ndef verify_v1_signature(payload: bytes, header_hash: str, secret: str) -> bool:\n    expected = hashlib.pbkdf2_hmac(\"sha256\", payload, secret.encode(), 200000).hex()\n    return expected == header_hash\n\n

Headers sent with every webhook

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Header	Version	Description
`Content-Type`	V1, V2	`application/json`
`User-Agent`	V1, V2	`Spoki/{version}`
`X-SPOKI-ACCOUNT`	V1, V2	Account ID
`X-SPOKI-HASH`	V1 only	PBKDF2-HMAC-SHA256 signature
`X-Spoki-Signature`	V2 only	`t={timestamp},v2={hmac_sha256_hex}`

","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"1aaf0d9e-9fd2-4358-b142-dbfcbc21dae1","id":"1aaf0d9e-9fd2-4358-b142-dbfcbc21dae1","name":"Webhooks","type":"folder"}},"urlObject":{"query":[],"variable":[]},"url":""},"response":[],"_postman_id":"90e16d10-0213-035d-45a2-1e39550ca4ce"}],"id":"1aaf0d9e-9fd2-4358-b142-dbfcbc21dae1","description":"

Webhooks are user-defined HTTP callbacks that are triggered by specific events. Whenever that trigger event occurs, the WhatsApp Business API client captures the event, collects the data, and immediately sends a notification (HTTPs request) to the Webhook URL configured in the Webhooks setup step.

Spoki Webhooks deliver real-time HTTP POST notifications to your server when events occur in your account — contacts created, messages received, templates updated, and more.V2 webhooks introduce minimal payloads by default, an expands system to request only the data you need, HMAC-SHA256 signature verification with replay protection.

For the purposes of this use case, your Webhooks server must be reachable and have HTTPs support and a valid SSL certificate.

To get Webhooks notifications, your application must subscribe.

Webhooks in Spoki

following these steps:

Navigate to Spoki / Integrations / Webhook.
\n
Click on 'Add Webhook', then select the webhook, and set the webhook URL. This URL is where a POST request will be sent from our server.
\n
Add the webhook.
\n

","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"id":"7277a7c9-7061-461e-86c9-1439eb46b273","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"7fdd2668-f5ed-4974-9c1c-b3b5ea851afb","type":"text/javascript","exec":[""]}}],"_postman_id":"1aaf0d9e-9fd2-4358-b142-dbfcbc21dae1"},{"name":"Webhook Contact in automation step","item":[{"name":"Contact in automation step","id":"909bd313-aa0f-407d-ac1b-91268713b5e9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"VIEW","header":[],"body":{"mode":"raw","raw":"{\n \"contact\": {\n \"id\": 10,\n \"phone\": \"{{phone}}\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"email\": \"john.doe@domain.com\",\n \"language\": \"en\",\n \"chat_link\": \"https://spoki.app/chats/fV1raxSvcEqOG6KSXOk4\",\n \"contactfield_set\": [\n {\n \"filed\": 13,\n \"visual_code\": \"%%CITY%%\",\n \"value\": \"Milano\"\n }\n ],\n \"contactfield_values\": {\n \"CITY\": \"Milano\"\n }\n },\n \"metadata\": {\n \"your_str_meta\": \"lorem ipsum\",\n \"your_int_meta\": 3,\n \"your_float_meta\": 42.5,\n \"your_bool_meta\": true\n }\n}","options":{"raw":{"language":"json"}}},"url":"","description":"

Receive Webhook From Spoki when a contact reaches the step.

1. HTTP Request Methods

You can select the HTTP method you want to use from the dropdown menu available in the webhook configuration, you can select between:

GET
\n
POST
\n
PUT
\n
PATCH
\n
DELETE
\n

2. Custom JSON Payload Creation

Use the provided text editor to build highly customized JSON payloads, including static fields, nested objects, and arrays. You have complete control over the structure of the payload. Ensure the JSON syntax is valid.

Supported Variable Types in the Payload:

System Objects (Variables): These start with {{ and end with }}. These variables represent predefined objects available in our system, such as:
\n
- {{ contact }}: Contains contact data (e.g., contact.first_name, contact.email).
  \n
- {{ metadata }}: Contains metadata related to the contact in the automation.
  \n
- {{ context }}: Contains context related to the contact in the automation.
  \n
- {{ automation }}: Contains the id of the current automation run.
  \n
\n

Important: For complex objects like contact or automation, it is not necessary to include the entire object if only a specific field is wanted. The object can be expanded to directly access its attributes using dot notation.

Example: Instead of including the entire {{ contact }} object, if only the first name is needed, use {{ contact.first_name }}. Similarly, for the automation ID, use {{ automation.id }}.
\n
Dynamic Fields: These start and end with %%.
\n
Example: %%FIRST_NAME%%
\n
Static Fields: Any literal text, numeric, boolean value inserted directly into the payload.
\n
Inner Objects: Nested JSON structures used to organize data.
\n
Arrays: Lists of values or objects.
\n

Example JSON Payload (with variables):

{\n  \"user_data\": {\n    \"name\": \"{{ contact.first_name }}\",\n    \"surname\": \"{{ contact.last_name }}\",\n    \"email\": \"{{ contact.email }}\",\n    \"name_list\": [\n      \"%%DYNAMIC_FIELD_1%%\",\n      \"%%DYNAMIC_FIELD_2%%\",\n      \"%%DYNAMIC_FIELD_3%%\"\n    ],\n    \"operation_status\": \"success\",\n    \"additional_details\": {\n      \"automation_info\": {\n        \"automation_id\": \"{{ automation.id }}\",\n        \"type\": \"whatsapp_campaign\",\n      },\n      \"context\": \"{{ context }}\",\n    }\n  }\n}\n\n

Example Final JSON Payload (simulated data with John Doe):

This example shows how the final payload might appear once all variables and dynamic fields have been resolved and populated with real data.

{\n  \"user_data\": {\n    \"name\": \"John\",\n    \"surname\": \"Doe\",\n    \"email\": \"john.doe@example.com\",\n    \"name_list\": [\n      \"John\"\n    ],\n    \"operation_status\": \"success\",\n    \"additional_details\": {\n      \"automation_info\": {\n        \"automation_id\": \"1234\",\n        \"type\": \"whatsapp_campaign\",\n      },\n      \"context\": {\n        \"%%FIRST_NAME%%\": \"John\",\n        \"%%FIRSTNAME%%\": \"John\",\n        \"%%LAST_NAME%%\": \"Doe\",\n        \"%%LASTNAME%%\": \"Doe\",\n        \"%%EMAIL%%\": \"john.doe@example.com\",\n        \"%%PHONE%%\": \"+123334445555\"\n      }\n    }\n  }\n}\n\n

3. Using Dynamic Fields in Headers and URLs

\n\n

Dynamic fields can be inserted not only within the payload but also within the values of request headers and directly in the URL.

You can press the Add Dynamic Field button near the URL field and the header's values fields to add a dynamic field to the request.

Customized URL Example:

https://your-webhook-url.com/endpoint/%%PHONE%%?first_name=%%FIRST_NAME%%\n\n

4. Response Handling (Webhook Response Parsing)

\n\n

This feature allows our platform to parse the response payload sent by your webhook and save specific data into pre-defined dynamic fields. To leverage this functionality, your webhook's response must be structured in JSON format.

How to configure response parsing:

Define Dynamic Fields: First, create the dynamic fields where you wish to save the response data (e.g. SPECIFIC_KEY_VALUE, EVENT_DATE, STATUS, MY_CONTACT_ID).
\n
Map JSON Paths: Specify the JSON Path within your webhook's JSON response that corresponds to the data to be extracted, and the dynamic field where it should be saved.
\n
Example (adapted from screenshots):
\n
- data.status -> STATUS: The value of the status field within the data object will be saved into the STATUS dynamic field.
  \n
- data.data.inner.updated_at -> EVENT_DATE: The value of the updated_at field within the inner object will be saved into the EVENT_DATE dynamic field.
  \n
- data.data.updated_contacts.0.contact_id -> MY_CONTACT_ID: The value of the contact_id field within the first object of the updated_contacts array will be saved into the MY_CONTACT_ID dynamic field.
  \n
\n

Example of a possible JSON response from your webhook:

{\n  \"status\": \"success\",\n  \"message\": \"Operation completed successfully\",\n  \"data\": {\n    \"transaction_id\": \"TXN_789012\",\n    \"response_timestamp\": \"2025-07-03T10:30:00Z\",\n    \"inner\": {\n      \"detail_description\": \"Data updated correctly\",\n      \"updated_at\": \"2025-07-03\"\n    },\n    \"updated_contacts\": [\n      {\n        \"contact_id\": \"TXN_789012\"\n      }\n    ]\n  }\n}\n\n

In this example, our platform will save:

\"success\" into the %%STATUS%% field.
\n
\"2025-07-03\" into the %%EVENT_DATE%% field.
\n
\"TXN_789012\" into the %%MY_CONTACT_ID%% field.
\n

cURL Example

Here is an example of how the final request might look using curl, a popular command-line tool for making HTTP requests. This example includes the payload with \"John Doe\" data and an example header.

curl -X POST \\\n  'https://your-webhook-url.com/endpoint' \\\n  -H 'Content-Type: application/json' \\\n  -H 'Authorization: Bearer YOUR_API_TOKEN' \\\n  -d '{\n    \"user_data\": {\n        \"name\": \"{{ contact.first_name }}\",\n        \"surname\": \"{{ contact.last_name }}\",\n        \"email\": \"{{ contact.email }}\",\n        \"name_list\": [\n            \"%%DYNAMIC_FIELD_1%%\",\n            \"%%DYNAMIC_FIELD_2%%\",\n            \"%%DYNAMIC_FIELD_3%%\"\n        ],\n        \"operation_status\": \"success\",\n        \"additional_details\": {\n            \"automation_info\": {\n                \"automation_id\": \"{{ automation.id }}\",\n                \"type\": \"whatsapp_campaign\",\n            },\n            \"context\": \"{{ context }}\",\n        }\n    }\n  }'\n\n

\n","auth":{"type":"apikey","apikey":{"value":"{{Api-Key}}","key":""},"isInherited":true,"source":{"_postman_id":"b0f8e61f-7a2d-488c-8c5b-2835b092a3f9","id":"b0f8e61f-7a2d-488c-8c5b-2835b092a3f9","name":"Spoki API","type":"collection"}},"urlObject":{"query":[],"variable":[]}},"response":[],"_postman_id":"909bd313-aa0f-407d-ac1b-91268713b5e9"}],"id":"45372124-4b8a-47fe-a61f-083608951866","_postman_id":"45372124-4b8a-47fe-a61f-083608951866","description":"","auth":{"type":"apikey","apikey":{"value":"{{Api-Key}}","key":""},"isInherited":true,"source":{"_postman_id":"b0f8e61f-7a2d-488c-8c5b-2835b092a3f9","id":"b0f8e61f-7a2d-488c-8c5b-2835b092a3f9","name":"Spoki API","type":"collection"}}},{"name":"Partners","item":[{"name":"Partners","item":[{"name":"Deprecated","item":[{"name":"Create Conversations Subrecharge - Software Vendor Only - DEPRECATED","id":"08b4b643-82be-4751-8cd8-689feabe9195","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"destination_account\": 1,\n \"conversations\": 250\n}","options":{"raw":{"language":"json"}}},"url":"{{Base-URL}}/api/1/partners/create_conversations_subrecharge/","auth":{"type":"apikey","apikey":{"value":"{{Api-Key}}","key":""},"isInherited":true,"source":{"_postman_id":"b0f8e61f-7a2d-488c-8c5b-2835b092a3f9","id":"b0f8e61f-7a2d-488c-8c5b-2835b092a3f9","name":"Spoki API","type":"collection"}},"urlObject":{"path":["api","1","partners","create_conversations_subrecharge",""],"host":["{{Base-URL}}"],"query":[],"variable":[]}},"response":[{"id":"36ec57e8-68b3-4677-aec3-a362fd93148c","name":"Create Conversations Subrecharge - Software Vendor Only","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"destination_account\": 1,\n \"conversations\": 250\n}","options":{"raw":{"language":"json"}}},"url":"{{Base-URL}}/api/1/partners/create_conversations_subrecharge/"},"status":"No Content","code":204,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"08b4b643-82be-4751-8cd8-689feabe9195"}],"id":"07ee92c7-a644-40b5-b9bc-39ac8936e3db","_postman_id":"07ee92c7-a644-40b5-b9bc-39ac8936e3db","description":"","auth":{"type":"apikey","apikey":{"value":"{{Api-Key}}","key":""},"isInherited":true,"source":{"_postman_id":"b0f8e61f-7a2d-488c-8c5b-2835b092a3f9","id":"b0f8e61f-7a2d-488c-8c5b-2835b092a3f9","name":"Spoki API","type":"collection"}}},{"name":"List, search and filter partners","id":"d4648867-bb34-4dfd-b453-996f1d9bd2af","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{Base-URL}}/api/1/partners/","auth":{"type":"apikey","apikey":{"value":"{{Api-Key}}","key":""},"isInherited":true,"source":{"_postman_id":"b0f8e61f-7a2d-488c-8c5b-2835b092a3f9","id":"b0f8e61f-7a2d-488c-8c5b-2835b092a3f9","name":"Spoki API","type":"collection"}},"urlObject":{"path":["api","1","partners",""],"host":["{{Base-URL}}"],"query":[],"variable":[]}},"response":[{"id":"f692b940-8ad0-4b68-8099-6e7c7e81f9c1","name":"200 OK","originalRequest":{"method":"GET","header":[],"url":"{{Base-URL}}/api/1/partners/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": 1,\n \"name\": \"MyPartner\",\n \"email\": \"email@email.com\",\n \"phone\": \"+391234567890\",\n \"logo\": \"src_to_logo\",\n \"extended_logo\": \"src_to_logo\"\n }\n]"}],"_postman_id":"d4648867-bb34-4dfd-b453-996f1d9bd2af"},{"name":"Get associated accounts","id":"7997bbc6-00ea-427b-912c-e7e2317c0cad","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{Base-URL}}/api/1/partners/accounts/","auth":{"type":"apikey","apikey":{"value":"{{Api-Key}}","key":""},"isInherited":true,"source":{"_postman_id":"b0f8e61f-7a2d-488c-8c5b-2835b092a3f9","id":"b0f8e61f-7a2d-488c-8c5b-2835b092a3f9","name":"Spoki API","type":"collection"}},"urlObject":{"path":["api","1","partners","accounts",""],"host":["{{Base-URL}}"],"query":[],"variable":[]}},"response":[{"id":"d7dee4c9-81b1-46d9-af45-b1c61c18f588","name":"200 OK","originalRequest":{"method":"GET","header":[],"url":"{{Base-URL}}/api/1/partners/accounts/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": 13128334,\n \"name\": \"MyShop\",\n \"current_credit\": 8556300,\n \"status\": \"Active\",\n \"default_language\": \"it\",\n \"phone\": \"3933312345678\",\n \"has_official_verification\": false,\n \"daily_limit\": 100000,\n \"phone_status\": \"🟢 Connected\",\n \"quality_score\": 1,\n \"quality_reasons\": null,\n \"is_active\": true,\n \"country_code\": \"\",\n \"estimated_available_conversations\": 85563,\n \"account_type\": 2,\n \"default_pricing_delta\": 0,\n \"low_credit_threshold\": 15000,\n \"has_low_credit_alert\": false,\n \"default_prefix\": \"+39\",\n \"default_country_code\": \"IT\",\n \"timezone\": \"Europe/Rome\",\n \"contacted_in_24h\": 150,\n \"contacted_in_7d\": 602\n }\n]"}],"_postman_id":"7997bbc6-00ea-427b-912c-e7e2317c0cad"},{"name":"Create Onboarding Link","id":"ff4002b7-ecec-4431-99c4-8a3545133516","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"account\": 1\n}","options":{"raw":{"language":"json"}}},"url":"{{Base-URL}}/api/1/partners/onboarding/","auth":{"type":"apikey","apikey":{"value":"{{Api-Key}}","key":""},"isInherited":true,"source":{"_postman_id":"b0f8e61f-7a2d-488c-8c5b-2835b092a3f9","id":"b0f8e61f-7a2d-488c-8c5b-2835b092a3f9","name":"Spoki API","type":"collection"}},"urlObject":{"path":["api","1","partners","onboarding",""],"host":["{{Base-URL}}"],"query":[],"variable":[]}},"response":[{"id":"ec6d06ee-d838-4e9f-9979-e206f7803bc1","name":"Create Onboarding Link","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"account\": 1\n}","options":{"raw":{"language":"json"}}},"url":"{{Base-URL}}/api/1/partners/onboarding/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"redirect_url\": \"\"\n}"}],"_postman_id":"ff4002b7-ecec-4431-99c4-8a3545133516"},{"name":"Create API Key For Account","id":"8179dbcb-0a9c-4437-83d7-ecd9f1ea6e9c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"account\": 1\n}","options":{"raw":{"language":"json"}}},"url":"{{Base-URL}}/api/1/partners/create_api_key_for_account/","auth":{"type":"apikey","apikey":{"value":"{{Api-Key}}","key":""},"isInherited":true,"source":{"_postman_id":"b0f8e61f-7a2d-488c-8c5b-2835b092a3f9","id":"b0f8e61f-7a2d-488c-8c5b-2835b092a3f9","name":"Spoki API","type":"collection"}},"urlObject":{"path":["api","1","partners","create_api_key_for_account",""],"host":["{{Base-URL}}"],"query":[],"variable":[]}},"response":[{"id":"1afa8191-2146-4124-9581-3dbd7ee40216","name":"Create API Key For Account","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"account\": 1\n}","options":{"raw":{"language":"json"}}},"url":"{{Base-URL}}/api/1/partners/create_api_key_for_account/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"api_key\": \"\"\n}"}],"_postman_id":"8179dbcb-0a9c-4437-83d7-ecd9f1ea6e9c"},{"name":"Revoke API Key For Account","id":"cf555789-8032-4d85-a979-a996be34deba","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"account\": 1\n}","options":{"raw":{"language":"json"}}},"url":"{{Base-URL}}/api/1/partners/revoke_api_key_for_account/","auth":{"type":"apikey","apikey":{"value":"{{Api-Key}}","key":""},"isInherited":true,"source":{"_postman_id":"b0f8e61f-7a2d-488c-8c5b-2835b092a3f9","id":"b0f8e61f-7a2d-488c-8c5b-2835b092a3f9","name":"Spoki API","type":"collection"}},"urlObject":{"path":["api","1","partners","revoke_api_key_for_account",""],"host":["{{Base-URL}}"],"query":[],"variable":[]}},"response":[{"id":"a0b6f073-57e0-4e66-825b-567a30b4a52d","name":"Create API Key For Account","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"account\": 1\n}","options":{"raw":{"language":"json"}}},"url":"{{Base-URL}}/api/1/partners/revoke_api_key_for_account/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"ok\"\n}"}],"_postman_id":"cf555789-8032-4d85-a979-a996be34deba"},{"name":"Add Software Vendor Clients","id":"1d91767d-1849-4e75-b83d-794c9c0c00de","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"[\n {\n \"account_name\": \"MyClient\",\n \"country\": \"it\",\n \"country_code\": \"IT\",\n \"email\": \"email@email.com\",\n \"first_name\": \"First name\",\n \"vat_amount\": 2200\n },\n {\n \"account_name\": \"MyClient2\",\n \"country\": \"it\",\n \"country_code\": \"IT\",\n \"email\": \"email@email.com\",\n \"first_name\": \"First name2\",\n \"vat_amount\": 2200\n }\n]","options":{"raw":{"language":"json"}}},"url":"{{Base-URL}}/api/1/partners/add_sv_clients/","auth":{"type":"apikey","apikey":{"value":"{{Api-Key}}","key":""},"isInherited":true,"source":{"_postman_id":"b0f8e61f-7a2d-488c-8c5b-2835b092a3f9","id":"b0f8e61f-7a2d-488c-8c5b-2835b092a3f9","name":"Spoki API","type":"collection"}},"urlObject":{"path":["api","1","partners","add_sv_clients",""],"host":["{{Base-URL}}"],"query":[],"variable":[]}},"response":[{"id":"f9c1f345-58bf-4826-a310-f5bbd0e4abf0","name":"Add Software Vendor Clients","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"[\n {\n \"account_name\": \"MyClient\",\n \"country\": \"it\",\n \"country_code\": \"IT\",\n \"email\": \"email@email.com\",\n \"first_name\": \"First name\",\n \"vat_amount\": 2200\n },\n {\n \"account_name\": \"MyClient2\",\n \"country\": \"it\",\n \"country_code\": \"IT\",\n \"email\": \"email@email.com\",\n \"first_name\": \"First name2\",\n \"vat_amount\": 2200\n }\n]","options":{"raw":{"language":"json"}}},"url":"{{Base-URL}}/api/1/partners/add_sv_clients/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.29.2"},{"key":"Date","value":"Fri, 10 Oct 2025 13:51:06 GMT"},{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"Content-Length","value":"1042"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept, origin, Accept-Language, Cookie"},{"key":"Allow","value":"POST, OPTIONS"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Language","value":"en"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"Strict-Transport-Security","value":"max-age=31536000"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"[\n {\n \"id\": 2336,\n \"name\": \"MyClient\",\n \"current_credit\": 0,\n \"status\": \"Created\",\n \"default_language\": \"it\",\n \"phone\": null,\n \"has_official_verification\": false,\n \"daily_limit\": 1000,\n \"phone_status\": \"Undefined\",\n \"quality_score\": 0,\n \"quality_reasons\": null,\n \"is_active\": false,\n \"country_code\": \"IT\",\n \"estimated_available_conversations\": 0,\n \"account_type\": 2,\n \"default_pricing_delta\": 0,\n \"low_credit_threshold\": 15000,\n \"has_low_credit_alert\": false,\n \"default_prefix\": \"+39\",\n \"default_country_code\": \"IT\",\n \"timezone\": \"Europe/Rome\",\n \"contacted_in_24h\": 0,\n \"contacted_in_7d\": 0\n },\n {\n \"id\": 2337,\n \"name\": \"MyClient2\",\n \"current_credit\": 0,\n \"status\": \"Created\",\n \"default_language\": \"it\",\n \"phone\": null,\n \"has_official_verification\": false,\n \"daily_limit\": 1000,\n \"phone_status\": \"Undefined\",\n \"quality_score\": 0,\n \"quality_reasons\": null,\n \"is_active\": false,\n \"country_code\": \"IT\",\n \"estimated_available_conversations\": 0,\n \"account_type\": 2,\n \"default_pricing_delta\": 0,\n \"low_credit_threshold\": 15000,\n \"has_low_credit_alert\": false,\n \"default_prefix\": \"+39\",\n \"default_country_code\": \"IT\",\n \"timezone\": \"Europe/Rome\",\n \"contacted_in_24h\": 0,\n \"contacted_in_7d\": 0\n }\n]"}],"_postman_id":"1d91767d-1849-4e75-b83d-794c9c0c00de"},{"name":"Create Meta Credit Subrecharge","id":"604323bf-d2b3-463c-aa2d-b93f5d348597","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"destination_account\": 1,\n \"amount\": 10000 /* in thousandths eg: 10 = 10 * 1000 */\n}","options":{"raw":{"language":"json"}}},"url":"{{Base-URL}}/api/1/partners/create_subrecharge/","auth":{"type":"apikey","apikey":{"value":"{{Api-Key}}","key":""},"isInherited":true,"source":{"_postman_id":"b0f8e61f-7a2d-488c-8c5b-2835b092a3f9","id":"b0f8e61f-7a2d-488c-8c5b-2835b092a3f9","name":"Spoki API","type":"collection"}},"urlObject":{"path":["api","1","partners","create_subrecharge",""],"host":["{{Base-URL}}"],"query":[],"variable":[]}},"response":[{"id":"57a40bfb-9b34-42c5-bd54-2a98c9c5fb77","name":"204 NO CONTENT","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"destination_account\": 1,\n \"amount\": 10000 /* in thousandths eg: 10 = 10 * 1000 */\n}","options":{"raw":{"language":"json"}}},"url":"{{Base-URL}}/api/1/partners/create_subrecharge/"},"status":"No Content","code":204,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"604323bf-d2b3-463c-aa2d-b93f5d348597"},{"name":"Set Account Profit Margins - Software Vendor Only","id":"e745d299-d131-4768-a47a-e42686c2183d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"destination_account\": 1,\n \"sms_profit_margin\": 49, /* in thousandths eg: 0,049 = 49 */\n \"sms_one_way_profit_margin\": 49, /* in thousandths eg: 0,049 = 49 */\n \"utility_profit_margin\": 49, /* in thousandths eg: 0,049 = 49 */\n \"authentication_profit_margin\": 49, /* in thousandths eg: 0,049 = 49 */\n \"marketing_profit_margin\": 49, /* in thousandths eg: 0,049 = 49 */\n \"service_profit_margin\": 49, /* in thousandths eg: 0,049 = 49 */\n \"conversation_profit_margin\": 49 /* in thousandths eg: 0,049 = 49 */\n}","options":{"raw":{"language":"json"}}},"url":"{{Base-URL}}/api/1/partners/set_profits/","auth":{"type":"apikey","apikey":{"value":"{{Api-Key}}","key":""},"isInherited":true,"source":{"_postman_id":"b0f8e61f-7a2d-488c-8c5b-2835b092a3f9","id":"b0f8e61f-7a2d-488c-8c5b-2835b092a3f9","name":"Spoki API","type":"collection"}},"urlObject":{"path":["api","1","partners","set_profits",""],"host":["{{Base-URL}}"],"query":[],"variable":[]}},"response":[{"id":"835ff76c-5bac-4004-96b2-5a90d4e58e45","name":"Set Account Profit Margins - Software Vendor Only","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"destination_account\": 1,\n \"amount\": 10000 /* in thousandths eg: 10 = 10 * 1000 */\n}","options":{"raw":{"language":"json"}}},"url":"{{Base-URL}}/api/1/partners/create_subrecharge/"},"status":"No Content","code":204,"_postman_previewlanguage":"","header":[],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":""}],"_postman_id":"e745d299-d131-4768-a47a-e42686c2183d"},{"name":"Move Credit From Account - Software Vendor Only","id":"65e247ed-2b64-4a44-9693-e2ade4795c35","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"account_id\": 1,\n \"credit_to_move\": 10000 /* in thousandths eg: 10 = 10000 */\n}","options":{"raw":{"language":"json"}}},"url":"{{Base-URL}}/api/1/partners/move_credit_from_account/","description":"

Moves available recharge credit from a Software Vendor partner's child account back into the partner's wallet, deducting it from the account

\n","auth":{"type":"apikey","apikey":{"value":"{{Api-Key}}","key":""},"isInherited":true,"source":{"_postman_id":"b0f8e61f-7a2d-488c-8c5b-2835b092a3f9","id":"b0f8e61f-7a2d-488c-8c5b-2835b092a3f9","name":"Spoki API","type":"collection"}},"urlObject":{"path":["api","1","partners","move_credit_from_account",""],"host":["{{Base-URL}}"],"query":[],"variable":[]}},"response":[{"id":"865df602-f9ac-441b-b7d5-15bea4714530","name":"Move Credit From Account - Software Vendor Only","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"account_id\": 1,\n \"credit_to_move\": 10000 /* in thousandths eg: 10 = 10000 */\n}","options":{"raw":{"language":"json"}}},"url":"{{Base-URL}}/api/1/partners/move_credit_from_account/"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"65e247ed-2b64-4a44-9693-e2ade4795c35"},{"name":"Get account report","id":"ed2792a4-2716-4fbc-b422-99d7bbf95218","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{Base-URL}}/api/1/partners/get_account_report/?account_id=1&granularity=2&startDate=YYYY-MM-DD&endDate=YYYY-MM-DD","auth":{"type":"apikey","apikey":{"value":"{{Api-Key}}","key":""},"isInherited":true,"source":{"_postman_id":"b0f8e61f-7a2d-488c-8c5b-2835b092a3f9","id":"b0f8e61f-7a2d-488c-8c5b-2835b092a3f9","name":"Spoki API","type":"collection"}},"urlObject":{"path":["api","1","partners","get_account_report",""],"host":["{{Base-URL}}"],"query":[{"key":"account_id","value":"1"},{"key":"granularity","value":"2"},{"key":"startDate","value":"YYYY-MM-DD"},{"key":"endDate","value":"YYYY-MM-DD"}],"variable":[]}},"response":[{"id":"0376ab28-6752-436b-8fde-bb59f81adeee","name":"Get account report","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{Base-URL}}/api/1/partners/get_account_report/?account_id=1&granularity=0&startDate=YYYY-MM-DD&endDate=YYYY-MM-DD","host":["{{Base-URL}}"],"path":["api","1","partners","get_account_report",""],"query":[{"key":"account_id","value":"1"},{"key":"granularity","value":"0","description":"Possible values: by DAY = 0; by MONTH = 2"},{"key":"startDate","value":"YYYY-MM-DD","description":"Format example: 2025-09-01"},{"key":"endDate","value":"YYYY-MM-DD","description":"Format example: 2025-09-30"}]}},"code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"granularity\": 0,\n \"reports\": {\n \"2025-09-01\": {\n \"whatsapp_channel\": {\n \"contacted_contacts_inbound\": 0,\n \"contacted_contacts_outbound\": 1,\n \"messages\": {\n \"incoming\": 10,\n \"template\": {\n \"otp\": {},\n \"transaction\": {},\n \"marketing\": {}\n },\n \"free\": {\n \"delivered\": 0,\n \"error\": 0,\n \"no_status\": 0,\n \"read\": 10,\n \"sent\": 0\n }\n },\n \"transaction_amount\": -280,\n \"recharge_amount\": 0,\n \"conversations\": {\n \"marketing\": 2,\n \"service\": 1\n }\n },\n \"sms_channel\": {\n \"contacted_contacts_inbound\": 0,\n \"contacted_contacts_outbound\": 0,\n \"messages\": {\n \"incoming\": 0,\n \"template\": {\n \"otp\": {},\n \"transaction\": {},\n \"marketing\": {}\n },\n \"free\": {}\n }\n },\n \"partner\": {\n \"amount_profit_in_thousandth\": 0,\n \"amount_profit_conversations_in_thousandth\": 0,\n \"amount_profit_whatsapp_templates_marketing_in_thousandth\": 0,\n \"amount_profit_whatsapp_templates_transactional_in_thousandth\": 0,\n \"amount_profit_whatsapp_templates_authentication_in_thousandth\": 0,\n \"amount_profit_whatsapp_messages_service_in_thousandth\": 0,\n \"amount_profit_sms_one_way_messages_in_thousandth\": 0,\n \"amount_profit_sms_two_way_messages_in_thousandth\": 0\n }\n },\n \"2025-09-02\": {\n \"whatsapp_channel\": {\n \"contacted_contacts_inbound\": 1,\n \"contacted_contacts_outbound\": 1,\n \"messages\": {\n \"incoming\": 1,\n \"template\": {\n \"otp\": {},\n \"transaction\": {},\n \"marketing\": {}\n },\n \"free\": {\n \"delivered\": 0,\n \"no_status\": 0,\n \"read\": 1,\n \"sent\": 0\n }\n },\n \"transaction_amount\": -70,\n \"recharge_amount\": 0,\n \"conversations\": {\n \"marketing\": 1\n }\n },\n \"sms_channel\": {\n \"contacted_contacts_inbound\": 0,\n \"contacted_contacts_outbound\": 0,\n \"messages\": {\n \"incoming\": 0,\n \"template\": {\n \"otp\": {},\n \"transaction\": {},\n \"marketing\": {}\n },\n \"free\": {}\n }\n },\n \"partner\": {\n \"amount_profit_in_thousandth\": 0,\n \"amount_profit_conversations_in_thousandth\": 0,\n \"amount_profit_whatsapp_templates_marketing_in_thousandth\": 0,\n \"amount_profit_whatsapp_templates_transactional_in_thousandth\": 0,\n \"amount_profit_whatsapp_templates_authentication_in_thousandth\": 0,\n \"amount_profit_whatsapp_messages_service_in_thousandth\": 0,\n \"amount_profit_sms_one_way_messages_in_thousandth\": 0,\n \"amount_profit_sms_two_way_messages_in_thousandth\": 0\n }\n },\n \"2025-09-03\": {\n \"whatsapp_channel\": {\n \"contacted_contacts_inbound\": 5,\n \"contacted_contacts_outbound\": 4,\n \"messages\": {\n \"incoming\": 12,\n \"template\": {\n \"otp\": {},\n \"transaction\": {},\n \"marketing\": {}\n },\n \"free\": {\n \"delivered\": 0,\n \"no_status\": 0,\n \"read\": 14,\n \"sent\": 0\n }\n },\n \"transaction_amount\": -35560,\n \"recharge_amount\": 35350,\n \"conversations\": {\n \"marketing\": 4,\n \"service\": 1\n }\n },\n \"sms_channel\": {\n \"contacted_contacts_inbound\": 0,\n \"contacted_contacts_outbound\": 0,\n \"messages\": {\n \"incoming\": 0,\n \"template\": {\n \"otp\": {},\n \"transaction\": {},\n \"marketing\": {}\n },\n \"free\": {}\n }\n },\n \"partner\": {\n \"amount_profit_in_thousandth\": 0,\n \"amount_profit_conversations_in_thousandth\": 0,\n \"amount_profit_whatsapp_templates_marketing_in_thousandth\": 0,\n \"amount_profit_whatsapp_templates_transactional_in_thousandth\": 0,\n \"amount_profit_whatsapp_templates_authentication_in_thousandth\": 0,\n \"amount_profit_whatsapp_messages_service_in_thousandth\": 0,\n \"amount_profit_sms_one_way_messages_in_thousandth\": 0,\n \"amount_profit_sms_two_way_messages_in_thousandth\": 0\n }\n },\n \"2025-09-04\": {\n \"whatsapp_channel\": {\n \"contacted_contacts_inbound\": 1,\n \"contacted_contacts_outbound\": 1,\n \"messages\": {\n \"incoming\": 3,\n \"template\": {\n \"otp\": {},\n \"transaction\": {},\n \"marketing\": {}\n },\n \"free\": {\n \"delivered\": 0,\n \"no_status\": 0,\n \"read\": 2,\n \"sent\": 0\n }\n },\n \"transaction_amount\": 0,\n \"recharge_amount\": 0,\n \"conversations\": {\n \"service\": 1\n }\n },\n \"sms_channel\": {\n \"contacted_contacts_inbound\": 0,\n \"contacted_contacts_outbound\": 0,\n \"messages\": {\n \"incoming\": 0,\n \"template\": {\n \"otp\": {},\n \"transaction\": {},\n \"marketing\": {}\n },\n \"free\": {}\n }\n },\n \"partner\": {\n \"amount_profit_in_thousandth\": 0,\n \"amount_profit_conversations_in_thousandth\": 0,\n \"amount_profit_whatsapp_templates_marketing_in_thousandth\": 0,\n \"amount_profit_whatsapp_templates_transactional_in_thousandth\": 0,\n \"amount_profit_whatsapp_templates_authentication_in_thousandth\": 0,\n \"amount_profit_whatsapp_messages_service_in_thousandth\": 0,\n \"amount_profit_sms_one_way_messages_in_thousandth\": 0,\n \"amount_profit_sms_two_way_messages_in_thousandth\": 0\n }\n },\n \"2025-09-05\": {\n \"whatsapp_channel\": {\n \"contacted_contacts_inbound\": 3,\n \"contacted_contacts_outbound\": 7,\n \"messages\": {\n \"incoming\": 15,\n \"template\": {\n \"otp\": {},\n \"transaction\": {},\n \"marketing\": {}\n },\n \"free\": {\n \"delivered\": 0,\n \"error\": 3,\n \"no_status\": 0,\n \"read\": 9,\n \"sent\": 0\n }\n },\n \"transaction_amount\": -280,\n \"recharge_amount\": 0,\n \"conversations\": {\n \"marketing\": 5,\n \"service\": 4\n }\n },\n \"sms_channel\": {\n \"contacted_contacts_inbound\": 0,\n \"contacted_contacts_outbound\": 3,\n \"messages\": {\n \"incoming\": 0,\n \"template\": {\n \"otp\": {},\n \"transaction\": {},\n \"marketing\": {}\n },\n \"free\": {\n \"delivered\": 3,\n \"no_status\": 0,\n \"sent\": 1\n }\n }\n },\n \"partner\": {\n \"amount_profit_in_thousandth\": 0,\n \"amount_profit_conversations_in_thousandth\": 0,\n \"amount_profit_whatsapp_templates_marketing_in_thousandth\": 0,\n \"amount_profit_whatsapp_templates_transactional_in_thousandth\": 0,\n \"amount_profit_whatsapp_templates_authentication_in_thousandth\": 0,\n \"amount_profit_whatsapp_messages_service_in_thousandth\": 0,\n \"amount_profit_sms_one_way_messages_in_thousandth\": 0,\n \"amount_profit_sms_two_way_messages_in_thousandth\": 0\n }\n },\n \"2025-09-08\": {\n \"whatsapp_channel\": {\n \"contacted_contacts_inbound\": 0,\n \"contacted_contacts_outbound\": 1,\n \"messages\": {\n \"incoming\": 11,\n \"template\": {\n \"otp\": {},\n \"transaction\": {},\n \"marketing\": {}\n },\n \"free\": {\n \"delivered\": 1,\n \"no_status\": 0,\n \"read\": 4,\n \"sent\": 0\n }\n },\n \"transaction_amount\": -70,\n \"recharge_amount\": 0,\n \"conversations\": {\n \"marketing\": 1,\n \"service\": 2\n }\n },\n \"sms_channel\": {\n \"contacted_contacts_inbound\": 0,\n \"contacted_contacts_outbound\": 0,\n \"messages\": {\n \"incoming\": 0,\n \"template\": {\n \"otp\": {},\n \"transaction\": {},\n \"marketing\": {}\n },\n \"free\": {}\n }\n },\n \"partner\": {\n \"amount_profit_in_thousandth\": 0,\n \"amount_profit_conversations_in_thousandth\": 0,\n \"amount_profit_whatsapp_templates_marketing_in_thousandth\": 0,\n \"amount_profit_whatsapp_templates_transactional_in_thousandth\": 0,\n \"amount_profit_whatsapp_templates_authentication_in_thousandth\": 0,\n \"amount_profit_whatsapp_messages_service_in_thousandth\": 0,\n \"amount_profit_sms_one_way_messages_in_thousandth\": 0,\n \"amount_profit_sms_two_way_messages_in_thousandth\": 0\n }\n },\n \"2025-09-09\": {\n \"whatsapp_channel\": {\n \"contacted_contacts_inbound\": 2,\n \"contacted_contacts_outbound\": 1,\n \"messages\": {\n \"incoming\": 19,\n \"template\": {\n \"otp\": {},\n \"transaction\": {},\n \"marketing\": {}\n },\n \"free\": {\n \"delivered\": 0,\n \"no_status\": 0,\n \"read\": 22,\n \"sent\": 0\n }\n },\n \"transaction_amount\": -200,\n \"recharge_amount\": 0,\n \"conversations\": {\n \"marketing\": 1,\n \"service\": 1\n }\n },\n \"sms_channel\": {\n \"contacted_contacts_inbound\": 0,\n \"contacted_contacts_outbound\": 0,\n \"messages\": {\n \"incoming\": 0,\n \"template\": {\n \"otp\": {},\n \"transaction\": {},\n \"marketing\": {}\n },\n \"free\": {}\n }\n },\n \"partner\": {\n \"amount_profit_in_thousandth\": 0,\n \"amount_profit_conversations_in_thousandth\": 0,\n \"amount_profit_whatsapp_templates_marketing_in_thousandth\": 0,\n \"amount_profit_whatsapp_templates_transactional_in_thousandth\": 0,\n \"amount_profit_whatsapp_templates_authentication_in_thousandth\": 0,\n \"amount_profit_whatsapp_messages_service_in_thousandth\": 0,\n \"amount_profit_sms_one_way_messages_in_thousandth\": 0,\n \"amount_profit_sms_two_way_messages_in_thousandth\": 0\n }\n },\n \"2025-09-11\": {\n \"whatsapp_channel\": {\n \"contacted_contacts_inbound\": 2,\n \"contacted_contacts_outbound\": 3,\n \"messages\": {\n \"incoming\": 24,\n \"template\": {\n \"otp\": {},\n \"transaction\": {},\n \"marketing\": {}\n },\n \"free\": {\n \"delivered\": 0,\n \"error\": 1,\n \"no_status\": 0,\n \"read\": 35,\n \"sent\": 0\n }\n },\n \"transaction_amount\": 0,\n \"recharge_amount\": 0,\n \"conversations\": {\n \"service\": 1\n }\n },\n \"sms_channel\": {\n \"contacted_contacts_inbound\": 0,\n \"contacted_contacts_outbound\": 0,\n \"messages\": {\n \"incoming\": 0,\n \"template\": {\n \"otp\": {},\n \"transaction\": {},\n \"marketing\": {}\n },\n \"free\": {}\n }\n },\n \"partner\": {\n \"amount_profit_in_thousandth\": 0,\n \"amount_profit_conversations_in_thousandth\": 0,\n \"amount_profit_whatsapp_templates_marketing_in_thousandth\": 0,\n \"amount_profit_whatsapp_templates_transactional_in_thousandth\": 0,\n \"amount_profit_whatsapp_templates_authentication_in_thousandth\": 0,\n \"amount_profit_whatsapp_messages_service_in_thousandth\": 0,\n \"amount_profit_sms_one_way_messages_in_thousandth\": 0,\n \"amount_profit_sms_two_way_messages_in_thousandth\": 0\n }\n },\n \"2025-09-12\": {\n \"whatsapp_channel\": {\n \"contacted_contacts_inbound\": 3,\n \"contacted_contacts_outbound\": 1,\n \"messages\": {\n \"incoming\": 14,\n \"template\": {\n \"otp\": {},\n \"transaction\": {},\n \"marketing\": {}\n },\n \"free\": {\n \"delivered\": 0,\n \"no_status\": 0,\n \"read\": 10,\n \"sent\": 0\n }\n },\n \"transaction_amount\": 0,\n \"recharge_amount\": 0,\n \"conversations\": {}\n },\n \"sms_channel\": {\n \"contacted_contacts_inbound\": 0,\n \"contacted_contacts_outbound\": 0,\n \"messages\": {\n \"incoming\": 0,\n \"template\": {\n \"otp\": {},\n \"transaction\": {},\n \"marketing\": {}\n },\n \"free\": {}\n }\n },\n \"partner\": {\n \"amount_profit_in_thousandth\": 0,\n \"amount_profit_conversations_in_thousandth\": 0,\n \"amount_profit_whatsapp_templates_marketing_in_thousandth\": 0,\n \"amount_profit_whatsapp_templates_transactional_in_thousandth\": 0,\n \"amount_profit_whatsapp_templates_authentication_in_thousandth\": 0,\n \"amount_profit_whatsapp_messages_service_in_thousandth\": 0,\n \"amount_profit_sms_one_way_messages_in_thousandth\": 0,\n \"amount_profit_sms_two_way_messages_in_thousandth\": 0\n }\n },\n \"2025-09-15\": {\n \"whatsapp_channel\": {\n \"contacted_contacts_inbound\": 1,\n \"contacted_contacts_outbound\": 2,\n \"messages\": {\n \"incoming\": 1,\n \"template\": {\n \"otp\": {},\n \"transaction\": {},\n \"marketing\": {}\n },\n \"free\": {\n \"delivered\": 0,\n \"no_status\": 0,\n \"read\": 8,\n \"sent\": -1\n }\n },\n \"transaction_amount\": -700,\n \"recharge_amount\": 0,\n \"conversations\": {\n \"marketing\": 2\n }\n },\n \"sms_channel\": {\n \"contacted_contacts_inbound\": 0,\n \"contacted_contacts_outbound\": 0,\n \"messages\": {\n \"incoming\": 0,\n \"template\": {\n \"otp\": {},\n \"transaction\": {},\n \"marketing\": {}\n },\n \"free\": {}\n }\n },\n \"partner\": {\n \"amount_profit_in_thousandth\": 43,\n \"amount_profit_conversations_in_thousandth\": 0,\n \"amount_profit_whatsapp_templates_marketing_in_thousandth\": 43,\n \"amount_profit_whatsapp_templates_transactional_in_thousandth\": 0,\n \"amount_profit_whatsapp_templates_authentication_in_thousandth\": 0,\n \"amount_profit_whatsapp_messages_service_in_thousandth\": 0,\n \"amount_profit_sms_one_way_messages_in_thousandth\": 0,\n \"amount_profit_sms_two_way_messages_in_thousandth\": 0\n }\n },\n \"2025-09-16\": {\n \"whatsapp_channel\": {\n \"contacted_contacts_inbound\": 0,\n \"contacted_contacts_outbound\": 1,\n \"messages\": {\n \"incoming\": 0,\n \"template\": {\n \"otp\": {},\n \"transaction\": {},\n \"marketing\": {}\n },\n \"free\": {\n \"delivered\": 2,\n \"no_status\": 0,\n \"sent\": 0\n }\n },\n \"transaction_amount\": -120200,\n \"recharge_amount\": 120000,\n \"conversations\": {\n \"marketing\": 1\n }\n },\n \"sms_channel\": {\n \"contacted_contacts_inbound\": 0,\n \"contacted_contacts_outbound\": 1,\n \"messages\": {\n \"incoming\": 0,\n \"template\": {\n \"otp\": {},\n \"transaction\": {},\n \"marketing\": {}\n },\n \"free\": {\n \"no_status\": 0,\n \"sent\": 1\n }\n }\n },\n \"partner\": {\n \"amount_profit_in_thousandth\": 96,\n \"amount_profit_conversations_in_thousandth\": 10,\n \"amount_profit_whatsapp_templates_marketing_in_thousandth\": 86,\n \"amount_profit_whatsapp_templates_transactional_in_thousandth\": 0,\n \"amount_profit_whatsapp_templates_authentication_in_thousandth\": 0,\n \"amount_profit_whatsapp_messages_service_in_thousandth\": 0,\n \"amount_profit_sms_one_way_messages_in_thousandth\": 0,\n \"amount_profit_sms_two_way_messages_in_thousandth\": 0\n }\n },\n \"2025-09-17\": {\n \"whatsapp_channel\": {\n \"contacted_contacts_inbound\": 0,\n \"contacted_contacts_outbound\": 0,\n \"messages\": {\n \"incoming\": 0,\n \"template\": {\n \"otp\": {},\n \"transaction\": {},\n \"marketing\": {}\n },\n \"free\": {}\n },\n \"transaction_amount\": 0,\n \"recharge_amount\": 0,\n \"conversations\": {}\n },\n \"sms_channel\": {\n \"contacted_contacts_inbound\": 0,\n \"contacted_contacts_outbound\": 1,\n \"messages\": {\n \"incoming\": 0,\n \"template\": {\n \"otp\": {},\n \"transaction\": {},\n \"marketing\": {}\n },\n \"free\": {\n \"no_status\": 0,\n \"sent\": 5\n }\n }\n },\n \"partner\": {\n \"amount_profit_in_thousandth\": 0,\n \"amount_profit_conversations_in_thousandth\": 0,\n \"amount_profit_whatsapp_templates_marketing_in_thousandth\": 0,\n \"amount_profit_whatsapp_templates_transactional_in_thousandth\": 0,\n \"amount_profit_whatsapp_templates_authentication_in_thousandth\": 0,\n \"amount_profit_whatsapp_messages_service_in_thousandth\": 0,\n \"amount_profit_sms_one_way_messages_in_thousandth\": 0,\n \"amount_profit_sms_two_way_messages_in_thousandth\": 0\n }\n }\n },\n \"channel_contacts\": {\n \"whatsapp\": {\n \"inbound\": 5,\n \"outbound\": 5\n },\n \"sms\": {\n \"inbound\": 0,\n \"outbound\": 1\n }\n }\n}"}],"_postman_id":"ed2792a4-2716-4fbc-b422-99d7bbf95218"},{"name":"Get account forecasts","id":"e21c31b2-da15-42c0-acff-2f2fa7bba0c5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{Base-URL}}/api/1/partners/get_account_forecasts/?account_id=1&country_code=IT","auth":{"type":"apikey","apikey":{"value":"{{Api-Key}}","key":""},"isInherited":true,"source":{"_postman_id":"b0f8e61f-7a2d-488c-8c5b-2835b092a3f9","id":"b0f8e61f-7a2d-488c-8c5b-2835b092a3f9","name":"Spoki API","type":"collection"}},"urlObject":{"path":["api","1","partners","get_account_forecasts",""],"host":["{{Base-URL}}"],"query":[{"key":"account_id","value":"1"},{"key":"country_code","value":"IT"}],"variable":[]}},"response":[{"id":"0f91f751-d28a-4001-b851-884f29a42f8a","name":"Get account forecasts","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{Base-URL}}/api/1/partners/get_account_forecasts/?account_id=1&country_code=IT","host":["{{Base-URL}}"],"path":["api","1","partners","get_account_forecasts",""],"query":[{"key":"account_id","value":"1","description":"Required"},{"key":"country_code","value":"IT"}]}},"code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"marketing_templates\": 17,\n \"utility_templates\": 80,\n \"authentication_templates\": 80,\n \"service_messages\": \"unlimited\",\n \"sms\": 29\n}"}],"_postman_id":"e21c31b2-da15-42c0-acff-2f2fa7bba0c5"}],"id":"3b2d5696-52df-4b89-a17d-77479aca88fc","_postman_id":"3b2d5696-52df-4b89-a17d-77479aca88fc","description":"","auth":{"type":"apikey","apikey":{"value":"{{Api-Key}}","key":""},"isInherited":true,"source":{"_postman_id":"b0f8e61f-7a2d-488c-8c5b-2835b092a3f9","id":"b0f8e61f-7a2d-488c-8c5b-2835b092a3f9","name":"Spoki API","type":"collection"}}},{"name":"Partner Roles","item":[{"name":"List, search, and filter roles","id":"4c353f0e-4830-4fa6-8f55-53cbcbf85998","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"X-Spoki-Api-Key","value":"{{Api-Key}}","type":"text"}],"url":"{{Base-URL}}/api/1/partner-roles/","description":"

Rate Limit: 5/min

\n","urlObject":{"path":["api","1","partner-roles",""],"host":["{{Base-URL}}"],"query":[{"disabled":true,"description":{"content":"

search by id, email, first_name, last_name

\n","type":"text/plain"},"key":"search","value":""}],"variable":[]}},"response":[{"id":"f8d1c98e-df97-4366-a80d-a8d9daaa4316","name":"200 OK","originalRequest":{"method":"GET","header":[{"key":"X-Spoki-Api-Key","value":"{{Api-Key}}","type":"text"}],"url":{"raw":"{{Base-URL}}/api/1/partner-roles/","host":["{{Base-URL}}"],"path":["api","1","partner-roles",""],"query":[{"key":"search","value":"","description":"search by id, email, first_name, last_name","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.27.0"},{"key":"Date","value":"Fri, 18 Oct 2024 14:16:22 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"3485"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept, origin, Accept-Language, Cookie"},{"key":"Allow","value":"GET, HEAD, OPTIONS"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Language","value":"en"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"Strict-Transport-Security","value":"max-age=31536000"}],"cookie":[],"responseTime":null,"body":"{\n \"count\": 1,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n {\n \"id\": 1,\n \"user\": {\n \"id\": 1,\n \"email\": \"email@email.com\",\n \"uid\": \"uid\",\n \"firstname\": \"Firstname\",\n \"surname\": \"Surname\",\n \"image\": \"\",\n \"is_service\": false\n },\n \"role\": \"Owner\",\n \"is_active\": true,\n \"created_datetime\": \"2025-08-12T15:44:27.578057+02:00\",\n \"updated_datetime\": \"2025-08-12T15:44:27.578061+02:00\"\n }\n ]\n}"}],"_postman_id":"4c353f0e-4830-4fa6-8f55-53cbcbf85998"},{"name":"Retrieve role","id":"c8f5720a-b5ac-4dff-aac6-a4d26701595e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"X-Spoki-Api-Key","value":"{{Api-Key}}","type":"text"}],"url":"{{Base-URL}}/api/1/partner-roles/{{id}}/","description":"

Rate Limit: 5/min

\n","urlObject":{"path":["api","1","partner-roles","{{id}}",""],"host":["{{Base-URL}}"],"query":[],"variable":[]}},"response":[{"id":"1a09b23a-9823-4eb3-b685-bb2bc8dceb61","name":"200 OK","originalRequest":{"method":"GET","header":[{"key":"X-Spoki-Api-Key","value":"{{Api-Key}}","type":"text"}],"url":"{{Base-URL}}/api/1/partner-roles/{{id}}/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.27.0"},{"key":"Date","value":"Fri, 18 Oct 2024 14:18:45 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"365"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept, origin, Accept-Language, Cookie"},{"key":"Allow","value":"GET, DELETE, HEAD, OPTIONS"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Language","value":"en"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"Strict-Transport-Security","value":"max-age=31536000"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 1,\n \"user\": {\n \"id\": 1,\n \"email\": \"email@email.com\",\n \"uid\": \"uid\",\n \"firstname\": \"Firstname\",\n \"surname\": \"Surname\",\n \"image\": \"\",\n \"is_service\": false\n },\n \"role\": \"Owner\",\n \"is_active\": true,\n \"created_datetime\": \"2025-08-12T15:44:27.578057+02:00\",\n \"updated_datetime\": \"2025-08-12T15:44:27.578061+02:00\"\n}"}],"_postman_id":"c8f5720a-b5ac-4dff-aac6-a4d26701595e"},{"name":"Generate Private Key","id":"fe1e10af-59b8-4ba9-b066-1681fee0ceba","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"X-Spoki-Api-Key","value":"{{Api-Key}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{}","options":{"raw":{"language":"json"}}},"url":"{{Base-URL}}/api/1/partner-roles/{{id}}/generate_private_key/","description":"

Rate Limit: 10/min

Generate Private Key of a Service User

\n","urlObject":{"path":["api","1","partner-roles","{{id}}","generate_private_key",""],"host":["{{Base-URL}}"],"query":[],"variable":[]}},"response":[{"id":"ab5542b4-f792-445e-bfc0-1cbefd26256a","name":"200 OK","originalRequest":{"method":"POST","header":[{"key":"X-Spoki-Api-Key","value":"{{Api-Key}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{}","options":{"raw":{"language":"json"}}},"url":"{{Base-URL}}/api/1/partner-roles/{{id}}/generate_private_key/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.27.0"},{"key":"Date","value":"Fri, 18 Oct 2024 14:22:59 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"66"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept, origin, Accept-Language, Cookie"},{"key":"Allow","value":"POST, OPTIONS"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Language","value":"en"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"Strict-Transport-Security","value":"max-age=31536000"}],"cookie":[],"responseTime":null,"body":"\"b5e0ce522de128e01d7c37d6aba8b5cac6f19c1c84e76872c469cdb1733v819d\""}],"_postman_id":"fe1e10af-59b8-4ba9-b066-1681fee0ceba"},{"name":"Has Private Key","id":"34506b29-a07f-441b-b009-4ef600f99759","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"X-Spoki-Api-Key","value":"{{Api-Key}}","type":"text"}],"url":"{{Base-URL}}/api/1/partner-roles/{{id}}/has_private_key/","description":"

Rate Limit: 10/min

\n","urlObject":{"path":["api","1","partner-roles","{{id}}","has_private_key",""],"host":["{{Base-URL}}"],"query":[],"variable":[]}},"response":[{"id":"3d9a483c-71e8-4226-ac34-95812b38cf39","name":"200 OK","originalRequest":{"method":"GET","header":[{"key":"X-Spoki-Api-Key","value":"{{Api-Key}}","type":"text"}],"url":"{{Base-URL}}/api/1/partner-roles/{{id}}/has_private_key/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.27.0"},{"key":"Date","value":"Fri, 18 Oct 2024 14:22:45 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"5"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept, origin, Accept-Language, Cookie"},{"key":"Allow","value":"GET, HEAD, OPTIONS"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Language","value":"en"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"Strict-Transport-Security","value":"max-age=31536000"}],"cookie":[],"responseTime":null,"body":"false"}],"_postman_id":"34506b29-a07f-441b-b009-4ef600f99759"},{"name":"Update Role","id":"fe267e27-7df8-4817-8c7a-cfb62dc9b25b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"X-Spoki-Api-Key","value":"{{Api-Key}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"role\": \"Chat Operator\"\n}","options":{"raw":{"language":"json"}}},"url":"{{Base-URL}}/api/1/partner-roles/{{id}}/update_role/","description":"

Rate Limit: 10/min

Possible Error Codes:

In case the body is correct, other error code:

{\n    \"type\": \"https://app.spoki.it/errors/spoki::3004\",\n    \"title\": \"The request body is not correct\",\n    \"code\": \"spoki::3004\",\n    \"status\": 400,\n    \"datail\": \"Invalid or no role specified.\"\n}\n\n

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Status	Code	Title	Datail
400	spoki::3004	The request body is not correct	Invalid or no role specified
403	spoki::403	Access denied	you cannot change the role of the sole admin of the account
400	spoki::3004	The request body is not correct	specify a valid role

","urlObject":{"path":["api","1","partner-roles","{{id}}","update_role",""],"host":["{{Base-URL}}"],"query":[],"variable":[]}},"response":[{"id":"3ee55871-e6f8-4257-8a79-3c125aa05265","name":"204 No Content","originalRequest":{"method":"POST","header":[{"key":"X-Spoki-Api-Key","value":"{{Api-Key}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"role\": \"Chat Operator Manager\"\n}","options":{"raw":{"language":"json"}}},"url":"{{Base-URL}}/api/1/partner-roles/{{id}}/update_role/"},"status":"No Content","code":204,"_postman_previewlanguage":"plain","header":[{"key":"Server","value":"nginx/1.27.0"},{"key":"Date","value":"Fri, 18 Oct 2024 14:23:30 GMT"},{"key":"Content-Length","value":"0"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept, origin, Accept-Language, Cookie"},{"key":"Allow","value":"POST, OPTIONS"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Language","value":"en"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"Strict-Transport-Security","value":"max-age=31536000"}],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"fe267e27-7df8-4817-8c7a-cfb62dc9b25b"},{"name":"Delete role","id":"e65cc202-45cd-4bae-8a76-e164bf458737","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"DELETE","header":[{"key":"X-Spoki-Api-Key","value":"{{Api-Key}}","type":"text"}],"url":"{{Base-URL}}/api/1/partner-roles/{{id}}/","description":"

Rate Limit: 5/min

Possible Error Codes:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Status	Code	Title	Datail
403	spoki::403	Access denied	you cannot delete the role of the sole admin of the account

","urlObject":{"path":["api","1","partner-roles","{{id}}",""],"host":["{{Base-URL}}"],"query":[],"variable":[]}},"response":[{"id":"f84c2be4-b23c-485e-abe5-5572ba6a0687","name":"204 No Content","originalRequest":{"method":"DELETE","header":[{"key":"X-Spoki-Api-Key","value":"{{Api-Key}}","type":"text"}],"url":"{{Base-URL}}/api/1/partner-roles/{{id}}/"},"status":"No Content","code":204,"_postman_previewlanguage":"plain","header":[{"key":"Server","value":"nginx/1.27.0"},{"key":"Date","value":"Fri, 18 Oct 2024 14:25:14 GMT"},{"key":"Content-Length","value":"0"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept, origin, Accept-Language, Cookie"},{"key":"Allow","value":"GET, DELETE, HEAD, OPTIONS"},{"key":"X-Frame-Options","value":"DENY"},{"key":"Content-Language","value":"en"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"Strict-Transport-Security","value":"max-age=31536000"}],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"e65cc202-45cd-4bae-8a76-e164bf458737"}],"id":"357267f1-8927-4fbc-8557-ce606aa09983","_postman_id":"357267f1-8927-4fbc-8557-ce606aa09983","description":"","auth":{"type":"apikey","apikey":{"value":"{{Api-Key}}","key":""},"isInherited":true,"source":{"_postman_id":"b0f8e61f-7a2d-488c-8c5b-2835b092a3f9","id":"b0f8e61f-7a2d-488c-8c5b-2835b092a3f9","name":"Spoki API","type":"collection"}}},{"name":"Partner Invitations","item":[{"name":"List, search, and filter invitations","id":"6d4bce23-7326-4ea4-a7de-7b023bd3ade9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"X-Spoki-Api-Key","value":"{{Api-Key}}","type":"text"}],"url":"{{Base-URL}}/api/1/partner-invitations/","description":"

Rate Limit: 5/min

\n","urlObject":{"path":["api","1","partner-invitations",""],"host":["{{Base-URL}}"],"query":[{"disabled":true,"description":{"content":"

search by id, email, first_name, last_name

\n","type":"text/plain"},"key":"search","value":""}],"variable":[]}},"response":[{"id":"57c192a3-5eb8-451d-974d-d6ffe625d5eb","name":"200 OK","originalRequest":{"method":"GET","header":[],"url":"{{Base-URL}}/api/1/partner-invitations/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 28 Aug 2023 12:17:17 GMT"},{"key":"Server","value":"WSGIServer/0.2 CPython/3.7.9"},{"key":"Content-Type","value":"application/json"},{"key":"Vary","value":"Accept, Origin, Cookie"},{"key":"Allow","value":"GET, POST, HEAD, OPTIONS"},{"key":"Server-Timing","value":"TimerPanel_utime;dur=2801.1810000000423;desc=\"User CPU time\", TimerPanel_stime;dur=593.042999999966;desc=\"System CPU time\", TimerPanel_total;dur=3394.2240000000083;desc=\"Total CPU time\", TimerPanel_total_time;dur=3741.213321685791;desc=\"Elapsed time\", SQLPanel_sql_time;dur=106.60886764526367;desc=\"SQL 33 queries\", CachePanel_total_time;dur=16.034841537475586;desc=\"Cache 4 Calls\""},{"key":"Content-Length","value":"2930"},{"key":"X-Frame-Options","value":"DENY"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"}],"cookie":[],"responseTime":null,"body":"{\n \"count\": 1,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n {\n \"id\": 1,\n \"email\": \"email@email.com\",\n \"role\": 1,\n \"additional_info\": null,\n \"created_datetime\": \"2025-09-22T17:14:54.979447+02:00\",\n \"partner_name\": \"Software Vendor\"\n }\n ]\n}"}],"_postman_id":"6d4bce23-7326-4ea4-a7de-7b023bd3ade9"},{"name":"Retrieve invitation","id":"6e82e47f-cc9e-4912-ae2b-d49105a0ad20","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"X-Spoki-Api-Key","value":"{{Api-Key}}","type":"text"}],"url":"{{Base-URL}}/api/1/partner-invitations/{{id}}/","description":"

Rate Limit: 5/min

\n","urlObject":{"path":["api","1","partner-invitations","{{id}}",""],"host":["{{Base-URL}}"],"query":[],"variable":[]}},"response":[{"id":"cc5e9c50-eb21-4be0-9fc5-7d72f84d669d","name":"200 OK","originalRequest":{"method":"GET","header":[{"key":"X-Spoki-Api-Key","value":"{{Api-Key}}","type":"text"}],"url":"{{Base-URL}}/api/1/partner-invitations/{{id}}/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.14.0 (Ubuntu)"},{"key":"Date","value":"Fri, 25 Aug 2023 08:24:08 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"604"},{"key":"Connection","value":"keep-alive"},{"key":"Allow","value":"GET, PUT, PATCH, DELETE, HEAD, OPTIONS"},{"key":"Vary","value":"Origin, Cookie"},{"key":"X-Frame-Options","value":"DENY"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Strict-Transport-Security","value":"max-age=31536000"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 1,\n \"email\": \"email@email.com\",\n \"role\": 1,\n \"additional_info\": null,\n \"created_datetime\": \"2025-09-22T17:14:54.979447+02:00\",\n \"partner_name\": \"Software Vendor\"\n}"}],"_postman_id":"6e82e47f-cc9e-4912-ae2b-d49105a0ad20"},{"name":"Invite new user by email","id":"53d2effb-28a4-424c-82a8-244b1b6205cd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"X-Spoki-Api-Key","value":"{{Api-Key}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"email\": \"john.doe@domain.com\",\n \"role\": \"Administrator\",\n \"additional_info\": {\n \"first_name\": \"John\",\n \"last_name\": \"Doe\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{Base-URL}}/api/1/partner-invitations/","description":"

Rate Limit: 10/min

Allowed roles: Owner, Administrator

Possible Error Codes:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Status	Code	Title	Datail
400	spoki::3004	Invalid request body	Invalid or no role specified
400	spoki::3004	Invalid request body	No email specified
400	spoki::3004	Invalid request body	No private_key specified
400	spoki::3007	Invalid request header	Invalid or no account specified
400	spoki::3007	Invalid request header	Invitation already exists

","urlObject":{"path":["api","1","partner-invitations",""],"host":["{{Base-URL}}"],"query":[],"variable":[]}},"response":[{"id":"65cfaaa8-c873-4cff-a1f0-bcb91e77c6cf","name":"201 Created","originalRequest":{"method":"POST","header":[{"key":"X-Spoki-Api-Key","value":"{{Api-Key}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"name\": \"MyCampaign\",\n \"scheduled_datetime\": \"2024-08-28T10:00:00.000Z\",\n \"status\": \"Scheduled\",\n \"automation\": {{id}},\n \"lists\": [{{id}}]\n}","options":{"raw":{"language":"json"}}},"url":"{{Base-URL}}/api/1/partner-invitations/"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 28 Aug 2023 12:25:37 GMT"},{"key":"Server","value":"WSGIServer/0.2 CPython/3.7.9"},{"key":"Content-Type","value":"application/json"},{"key":"Vary","value":"Accept, Origin, Cookie"},{"key":"Allow","value":"GET, POST, HEAD, OPTIONS"},{"key":"Server-Timing","value":"TimerPanel_utime;dur=1296.68700000002;desc=\"User CPU time\", TimerPanel_stime;dur=267.5800000000663;desc=\"System CPU time\", TimerPanel_total;dur=1564.2670000000862;desc=\"Total CPU time\", TimerPanel_total_time;dur=1593.4910774230957;desc=\"Elapsed time\", SQLPanel_sql_time;dur=29.886484146118164;desc=\"SQL 9 queries\", CachePanel_total_time;dur=4.533052444458008;desc=\"Cache 4 Calls\""},{"key":"Content-Length","value":"184"},{"key":"X-Frame-Options","value":"DENY"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 1,\n \"email\": \"email@email.com\",\n \"role\": 1,\n \"additional_info\": null,\n \"created_datetime\": \"2025-09-22T17:14:54.979447+02:00\",\n \"partner_name\": \"Software Vendor\"\n}"}],"_postman_id":"53d2effb-28a4-424c-82a8-244b1b6205cd"},{"name":"Resend invitation email","id":"81cc7514-4791-4f8a-b964-5a0c37fc1993","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"X-Spoki-Api-Key","value":"{{Api-Key}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{}","options":{"raw":{"language":"json"}}},"url":"{{Base-URL}}/api/1/partner-invitations/{{id}}/send/","description":"

Rate Limit: 5/min

\n","urlObject":{"path":["api","1","partner-invitations","{{id}}","send",""],"host":["{{Base-URL}}"],"query":[],"variable":[]}},"response":[{"id":"14f07ae9-24d8-4531-92b8-6c7a593b3cba","name":"201 Created","originalRequest":{"method":"POST","header":[{"key":"X-Spoki-Api-Key","value":"{{Api-Key}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"name\": \"MyCampaign\",\n \"scheduled_datetime\": \"2024-08-28T10:00:00.000Z\",\n \"status\": \"Scheduled\",\n \"automation\": {{id}},\n \"lists\": [{{id}}]\n}","options":{"raw":{"language":"json"}}},"url":"{{Base-URL}}/api/1/partner-invitations/{{id}}/send/"},"status":"No Content","code":204,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 28 Aug 2023 12:25:37 GMT"},{"key":"Server","value":"WSGIServer/0.2 CPython/3.7.9"},{"key":"Content-Type","value":"application/json"},{"key":"Vary","value":"Accept, Origin, Cookie"},{"key":"Allow","value":"GET, POST, HEAD, OPTIONS"},{"key":"Server-Timing","value":"TimerPanel_utime;dur=1296.68700000002;desc=\"User CPU time\", TimerPanel_stime;dur=267.5800000000663;desc=\"System CPU time\", TimerPanel_total;dur=1564.2670000000862;desc=\"Total CPU time\", TimerPanel_total_time;dur=1593.4910774230957;desc=\"Elapsed time\", SQLPanel_sql_time;dur=29.886484146118164;desc=\"SQL 9 queries\", CachePanel_total_time;dur=4.533052444458008;desc=\"Cache 4 Calls\""},{"key":"Content-Length","value":"184"},{"key":"X-Frame-Options","value":"DENY"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"81cc7514-4791-4f8a-b964-5a0c37fc1993"},{"name":"Update role","id":"4b7edcfc-1329-496d-b03d-53d06439f54e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"X-Spoki-Api-Key","value":"{{Api-Key}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"role\": \"Chat Operator Manager\"\n}","options":{"raw":{"language":"json"}}},"url":"{{Base-URL}}/api/1/partner-invitations/{{id}}/update_role/","description":"

Rate Limit: 5/min

Allowed roles: Owner, Administrator

Possible Error Codes:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Status	Code	Title	Datail
400	spoki::3004	Invalid request body	Invalid or no role specified

","urlObject":{"path":["api","1","partner-invitations","{{id}}","update_role",""],"host":["{{Base-URL}}"],"query":[],"variable":[]}},"response":[{"id":"a350e27d-0546-42b9-a41d-6b8f4ba6e162","name":"201 Created","originalRequest":{"method":"POST","header":[{"key":"X-Spoki-Api-Key","value":"{{Api-Key}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"name\": \"MyCampaign\",\n \"scheduled_datetime\": \"2024-08-28T10:00:00.000Z\",\n \"status\": \"Scheduled\",\n \"automation\": {{id}},\n \"lists\": [{{id}}]\n}","options":{"raw":{"language":"json"}}},"url":"{{Base-URL}}/api/1/partner-invitations/{{id}}/update_role/"},"status":"No Content","code":204,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 28 Aug 2023 12:25:37 GMT"},{"key":"Server","value":"WSGIServer/0.2 CPython/3.7.9"},{"key":"Content-Type","value":"application/json"},{"key":"Vary","value":"Accept, Origin, Cookie"},{"key":"Allow","value":"GET, POST, HEAD, OPTIONS"},{"key":"Server-Timing","value":"TimerPanel_utime;dur=1296.68700000002;desc=\"User CPU time\", TimerPanel_stime;dur=267.5800000000663;desc=\"System CPU time\", TimerPanel_total;dur=1564.2670000000862;desc=\"Total CPU time\", TimerPanel_total_time;dur=1593.4910774230957;desc=\"Elapsed time\", SQLPanel_sql_time;dur=29.886484146118164;desc=\"SQL 9 queries\", CachePanel_total_time;dur=4.533052444458008;desc=\"Cache 4 Calls\""},{"key":"Content-Length","value":"184"},{"key":"X-Frame-Options","value":"DENY"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"4b7edcfc-1329-496d-b03d-53d06439f54e"},{"name":"Delete invitation","id":"c2cdbfcd-7961-487e-979e-2f9d3e35343e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"DELETE","header":[{"key":"X-Spoki-Api-Key","value":"{{Api-Key}}","type":"text"}],"url":"{{Base-URL}}/api/1/partner-invitations/{{id}}/","description":"

Rate Limit: 10/min

\n","urlObject":{"path":["api","1","partner-invitations","{{id}}",""],"host":["{{Base-URL}}"],"query":[],"variable":[]}},"response":[{"id":"4ddaebd7-bf2f-43e9-abbb-6b4fe31b07ca","name":"204 No Content","originalRequest":{"method":"DELETE","header":[{"key":"X-Spoki-Api-Key","value":"{{Api-Key}}","type":"text"}],"url":"{{Base-URL}}/api/1/partner-invitations/{{id}}/"},"status":"No Content","code":204,"_postman_previewlanguage":"plain","header":[{"key":"Date","value":"Mon, 28 Aug 2023 12:26:38 GMT"},{"key":"Server","value":"WSGIServer/0.2 CPython/3.7.9"},{"key":"Vary","value":"Accept, Origin, Cookie"},{"key":"Allow","value":"GET, PUT, PATCH, DELETE, HEAD, OPTIONS"},{"key":"Server-Timing","value":"TimerPanel_utime;dur=1070.9779999999682;desc=\"User CPU time\", TimerPanel_stime;dur=224.4150000000218;desc=\"System CPU time\", TimerPanel_total;dur=1295.39299999999;desc=\"Total CPU time\", TimerPanel_total_time;dur=1268.4416770935059;desc=\"Elapsed time\", SQLPanel_sql_time;dur=18.60809326171875;desc=\"SQL 6 queries\", CachePanel_total_time;dur=6.557226181030273;desc=\"Cache 4 Calls\""},{"key":"Content-Length","value":"0"},{"key":"X-Frame-Options","value":"DENY"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"}],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"c2cdbfcd-7961-487e-979e-2f9d3e35343e"}],"id":"0c5b4ca9-6311-46ab-8aca-7cc07395a6b8","_postman_id":"0c5b4ca9-6311-46ab-8aca-7cc07395a6b8","description":"","auth":{"type":"apikey","apikey":{"value":"{{Api-Key}}","key":""},"isInherited":true,"source":{"_postman_id":"b0f8e61f-7a2d-488c-8c5b-2835b092a3f9","id":"b0f8e61f-7a2d-488c-8c5b-2835b092a3f9","name":"Spoki API","type":"collection"}}}],"id":"ef07710a-b71f-4581-a7b5-99c97817ce82","_postman_id":"ef07710a-b71f-4581-a7b5-99c97817ce82","description":"","auth":{"type":"apikey","apikey":{"value":"{{Api-Key}}","key":""},"isInherited":true,"source":{"_postman_id":"b0f8e61f-7a2d-488c-8c5b-2835b092a3f9","id":"b0f8e61f-7a2d-488c-8c5b-2835b092a3f9","name":"Spoki API","type":"collection"}}},{"name":"Channels","item":[{"name":"List channels","id":"a16826e2-028d-42d7-a5a0-df28f85ff5d9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Api-Key","value":"{{Api-Key}}"}],"url":"{{Base-URL}}/api/1/channel/","description":"

Returns the tenant's channels, all lifecycle states included (Onboarding Started → Disconnected). Reads from replica DB.

Request

GET /api/1/channel/\n\n

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Query param	Type	Default	Notes
`whatsapp_business_account`	string	—	Filter by Meta WABA id
`waba`	string	—	Alias for the param above
`page`	integer	1	1-based page number
`page_size`	integer	15	Max 30

Response 200

{\n  \"count\": 13,\n  \"next\": \"https://…?page=2\",\n  \"previous\": null,\n  \"results\": [ { /* AccountChannel */ }, … ]\n}\n\n

AccountChannel object

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Notes
`id`	The unique identifier of the Account Chann
`name`	Label associated with the channel
`identifier`	Platform address (phone number, SIP URI, …)
`client_id`	Meta WABA id — only set for WhatsApp channels
`platform`	See platform codes below
`is_primary`	Per-platform routing flag. Set via `POST /channel/{id}/set-primary/`
`status`	`1` Onboarding Started · `2` Connected · `3` Active · `4` Disconnected
`quality_score`	Meta WA quality rating: `0` Unknown · `1` Green · `2` Yellow · `3` Red
`phone_status`	Meta per-phone status (11 values, WhatsApp only)
`metadata`	Opaque provider blob — read-only

Platform codes

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Value	Label
`1`	WhatsApp
`3`	SMS one-way

phone_status codes (WhatsApp only)

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Value	Label
`0`	Unknown
`1`	Pending
`2`	Offline
`3`	Flagged
`4`	Connected
`5`	Rate Limited
`6`	Warned
`7`	Restricted
`8`	Integrity Violation
`9`	Banned
`10`	Deleted

Errors

\n\n\n\n\n\n\n\n\n\n\n\n\n

Status	Meaning
`401`	Invalid or missing API key

","auth":{"type":"apikey","apikey":{"value":"{{Api-Key}}","key":""},"isInherited":true,"source":{"_postman_id":"b0f8e61f-7a2d-488c-8c5b-2835b092a3f9","id":"b0f8e61f-7a2d-488c-8c5b-2835b092a3f9","name":"Spoki API","type":"collection"}},"urlObject":{"path":["api","1","channel",""],"host":["{{Base-URL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"a16826e2-028d-42d7-a5a0-df28f85ff5d9"},{"name":"Retrieve channel","id":"f1e12254-c9db-4d5d-9fd6-02e7875af645","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{Base-URL}}/api/1/channel/{{id_channel}}/","description":"

Tenant-scoped lookup by id. No status filter — returns the row regardless of its lifecycle state.

Request

GET /api/1/channel/{id}/\n

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Param	Type	Description
`id`	integer	Channel row id. Must be numeric — non-numeric segments return `404`.

Response 200

The full 10-field AccountChannel object. See List channels for the complete field reference.

Errors

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Status	Body	When
`404`	`{ \"detail\": \"No AccountChannel matches the given query.\" }`	Unknown id, cross-tenant id, or non-numeric path segment

","auth":{"type":"apikey","apikey":{"value":"{{Api-Key}}","key":""},"isInherited":true,"source":{"_postman_id":"b0f8e61f-7a2d-488c-8c5b-2835b092a3f9","id":"b0f8e61f-7a2d-488c-8c5b-2835b092a3f9","name":"Spoki API","type":"collection"}},"urlObject":{"path":["api","1","channel","{{id_channel}}",""],"host":["{{Base-URL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"f1e12254-c9db-4d5d-9fd6-02e7875af645"},{"name":"Create channel","id":"9db33535-0929-4b14-afeb-0f127bd69a56","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","disabled":false}],"body":{"mode":"raw","raw":"{\"platform\": 6, \"name\": \"Lifecycle voice\", \"is_primary\": false, \"identifier\": \"+39...\"}","options":{"raw":{"language":"json"}}},"url":"{{Base-URL}}/api/1/channel/","description":"

Branches on the platform value in the body. WhatsApp and one-way SMS go through provider helpers and return provider-specific shapes; everything else is a direct insert and returns the standard 10-field AccountChannel payload.

Request

POST /api/1/channel/\n\n

Request body — writable fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Default	Description
`platform`	integer (enum)	yes	—	One of 1–10. Drives the branch. See platform enum in List channels.
`name`	string	no	null	Operator label. Max 256 chars.
`is_primary`	boolean	no	false	If `true`, demotes the current primary on (account, platform) before inserting.
`identifier`	string	conditional	null	Required for SMS one-way (profile name, ≤ 11 chars). Ignored for WhatsApp on POST (Tyntec sets it via callback). For other platforms it's the phone number — recommended but not enforced.

All other fields in the body are silently dropped (status, client_id, metadata, quality_score, phone_status cannot be set on POST).

Branch A — `platform = 1` (WhatsApp): Tyntec onboarding

The row is created with status Onboarding Started. The response body is the Tyntec redirect, not the channel object (200, not 201).

Response 200

{\n  \"redirect_url\": \"https://app.spoki.com/external-activation?auth_token=…&lang=it\",\n  \"auth_token\": \"82a1…\",\n  \"lang\": \"it\"\n}\n\n

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Description
`redirect_url`	string	Send the end user here to complete Tyntec consent.
`auth_token`	string	One-time onboarding token; the webhook callback uses it to locate the row.
`lang`	string	ISO 639-1 code resolved from user → account → `\"en\"`.

After the user completes the Tyntec flow, status, identifier, client_id, phone_status, quality_score, and metadata are populated by the webhook. Poll GET /channel/{id}/ to observe the transition.

Branch B — `platform = 3` (SMS one-way): profile-name review

identifier is used as the SMS profile name (≤ 11 chars, non-empty after trim).

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

HTTP	Body	Meaning
`200 OK`	`{ \"sms_profile_name\": \"ACMECORP\", \"approved\": true }`	Auto-approved. Row status → `Active`.
`202 Accepted`	`{ \"message\": \"Request received. You'll be notified via email once reviewed.\", \"approved\": false }`	Submitted for manual review. Row status → `Connected`.
`400`	`{ \"detail\": \"'sms_profile_name' is required\" }`	`identifier` missing or empty.
`400`	`{ \"detail\": \"'sms_profile_name' must be at most 11 characters\" }`	`identifier` too long.

Branch C — all other platforms: direct insert

Response 201 Created — the full 10-field AccountChannel object. The new row's status defaults to 1 (Onboarding Started); provider activation flips it later.

Behavior notes

is_primary: true on POST runs a per-platform demote before the insert — a Voice primary is unaffected when you create an SMS two-ways primary.
\n
No identifier uniqueness check at the API level. Duplicates across tenants and across platforms within a tenant are allowed.
\n
All 10 platform values are accepted (no external whitelist).
\n

Errors

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Status	Body	When
`400`	`{ \"platform\": [\"This field is required.\"] }`	Missing `platform`.
`400`	`{ \"platform\": [\"\\\"99\\\" is not a valid choice.\"] }`	Out-of-range `platform`.
`400`	`{ \"detail\": \"'sms_profile_name' is required\" }`	Branch B — empty `identifier`.
`400`	`{ \"detail\": \"'sms_profile_name' must be at most 11 characters\" }`	Branch B — `identifier` too long.

","auth":{"type":"apikey","apikey":{"value":"{{Api-Key}}","key":""},"isInherited":true,"source":{"_postman_id":"b0f8e61f-7a2d-488c-8c5b-2835b092a3f9","id":"b0f8e61f-7a2d-488c-8c5b-2835b092a3f9","name":"Spoki API","type":"collection"}},"urlObject":{"path":["api","1","channel",""],"host":["{{Base-URL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"9db33535-0929-4b14-afeb-0f127bd69a56"},{"name":"Rename channel","id":"3872909c-3ced-4136-bb5c-df7dd8f7200e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json","disabled":false}],"body":{"mode":"raw","raw":"{\"name\": \"Renamed\"}","options":{"raw":{"language":"json"}}},"url":"{{Base-URL}}/api/1/channel/{{id_channel}}/","description":"

Renames a channel. Only name is writable — every other field in the body is silently dropped (no validation error, just ignored). This is enforced by the serializer contract (Meta.fields = [\"name\"]).

Request

PATCH /api/1/channel/{id}/\n\n

PUT /channel/{id}/ is also accepted with identical writable-field rules.

Example — extra fields are silently dropped

PATCH /api/1/channel/17/\nX-Spoki-Api-Key: {{Api-Key}}\nContent-Type: application/json\n{ \"name\": \"Renamed\", \"identifier\": \"+99…\", \"status\": 4 }\n\n

Effective body: { \"name\": \"Renamed\" }. identifier and status are dropped.

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Param	Type	Description
`id`	integer	ID of the channel to rename. Non-numeric or unknown values return `404`.

Request body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Required	Description
`name`	string	no	New label for the channel. `null` and empty string are accepted. All other fields are silently ignored.

Response 200 OK

Full 10-field AccountChannel object reflecting the post-save state. See List channels for the complete schema.

Errors

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Status	Body	When
`404`	`{ \"detail\": \"No AccountChannel matches the given query.\" }`	Unknown id, cross-tenant id, or non-numeric id.

","auth":{"type":"apikey","apikey":{"value":"{{Api-Key}}","key":""},"isInherited":true,"source":{"_postman_id":"b0f8e61f-7a2d-488c-8c5b-2835b092a3f9","id":"b0f8e61f-7a2d-488c-8c5b-2835b092a3f9","name":"Spoki API","type":"collection"}},"urlObject":{"path":["api","1","channel","{{id_channel}}",""],"host":["{{Base-URL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"3872909c-3ced-4136-bb5c-df7dd8f7200e"},{"name":"Set primary channel","id":"16271644-6381-4d86-8210-22bda52e05c2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"{{Base-URL}}/api/1/channel/{{id_channel}}/set-primary/","description":"

Promotes this channel to is_primary = true for its platform, and atomically demotes every other channel that was previously primary on the same (account, platform) pair.

The DB partial unique index unique_primary_channel_per_account_platform guarantees that after this call exactly one channel per (account, platform) has is_primary = true.

Endpoint

POST /api/1/channel/{id}/set-primary/\n

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`id`	integer	Yes	Primary key of the `AccountChannel` to promote. Non-numeric or unknown values return `404`.

Request body

No body is required. An empty JSON object {} or a completely empty body are both accepted.

Example request

POST /api/1/channel/17/set-primary/\nX-Spoki-Api-Key: {{Api-Key}}\nContent-Type: application/json\n\n{}\n

Behavior

The target channel's is_primary flag is set to true.
Every other channel belonging to the same account and same platform that currently has is_primary = true is demoted to is_primary = false (per-platform demote, mirroring the wazy helper).
Channels on different platforms are never affected. After this call an account may legitimately have multiple primaries — one per platform (e.g. one WhatsApp primary + one SMS primary + one Voice primary).
The operation is atomic; the DB partial unique index unique_primary_channel_per_account_platform enforces the invariant at the database level.

Response — 200 OK

Returns the full AccountChannel object for the promoted channel, with is_primary: true.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Notes
`id`	integer	Channel primary key
`name`	string	Human-readable label
`phone`	string	E.164 phone number
`platform`	integer	Platform code (unchanged by this call)
`status`	integer	Activation status (unchanged by this call)
`is_primary`	boolean	`true` after this call
`phone_status`	integer	Provider-side phone status (unchanged)
`quality_score`	string / null	WhatsApp quality score (unchanged)
`waba_id`	string / null	WhatsApp Business Account ID (unchanged)
`account`	integer	Owning account ID

Example response

{\n  \"id\": 17,\n  \"name\": \"Main WhatsApp\",\n  \"phone\": \"+39012345678\",\n  \"platform\": 1,\n  \"status\": 2,\n  \"is_primary\": true,\n  \"phone_status\": 2,\n  \"quality_score\": \"GREEN\",\n  \"waba_id\": \"123456789012345\",\n  \"account\": 42\n}\n

Other primaries on the same (account, platform) are now is_primary: false but are not returned in this response.

Errors

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

HTTP status	Body	When
`404 Not Found`	`{ \"detail\": \"No AccountChannel matches the given query.\" }`	Unknown `id` or channel belongs to a different tenant.

","auth":{"type":"apikey","apikey":{"value":"{{Api-Key}}","key":""},"isInherited":true,"source":{"_postman_id":"b0f8e61f-7a2d-488c-8c5b-2835b092a3f9","id":"b0f8e61f-7a2d-488c-8c5b-2835b092a3f9","name":"Spoki API","type":"collection"}},"urlObject":{"path":["api","1","channel","{{id_channel}}","set-primary",""],"host":["{{Base-URL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"16271644-6381-4d86-8210-22bda52e05c2"},{"name":"Refresh WhatsApp phone status","id":"aa4968ab-f535-4f3c-a34b-72fb2ed32866","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"{{Base-URL}}/api/1/channel/{{id_channel}}/refresh-wa-status/","description":"

Enqueues a task that re-pings Meta for the latest WhatsApp phone status and quality score. The endpoint returns immediately; the actual update happens asynchronously.

Fields updated by the background task: phone_status, quality_score, and — if the derived activation state has changed — status and related metadata.

Endpoint

POST /api/1/channel/{id}/refresh-wa-status/\n\n

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Required	Description
`id`	integer	Yes	Primary key of the `AccountChannel` to refresh. Non-numeric or unknown values return `404`.

Request body

No body. Do not send a Content-Type header.

Example request

POST /api/1/channel/6/refresh-wa-status/\nX-Spoki-Api-Key: {{Api-Key}}\n\n

Response — 204 No Content

Empty body. The task has been enqueued (or the cache window is still active — see Caching below). Either way the response is always 204.

To observe the updated values, poll the channel afterwards:

GET /api/1/channel/{id}/\n\n

Errors

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

HTTP status	Body	When
`404 Not Found`	`{ \"detail\": \"No AccountChannel matches the given query.\" }`	Unknown `id` or channel belongs to a different tenant.

","auth":{"type":"apikey","apikey":{"value":"{{Api-Key}}","key":""},"isInherited":true,"source":{"_postman_id":"b0f8e61f-7a2d-488c-8c5b-2835b092a3f9","id":"b0f8e61f-7a2d-488c-8c5b-2835b092a3f9","name":"Spoki API","type":"collection"}},"urlObject":{"path":["api","1","channel","{{id_channel}}","refresh-wa-status",""],"host":["{{Base-URL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"aa4968ab-f535-4f3c-a34b-72fb2ed32866"},{"name":"Lookup channel by phone","id":"d39f500a-7d26-465a-b8f5-20dbb5e4c9fa","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-Spoki-Api-Key","value":"{{Api-Key}}","disabled":false}],"url":"{{Base-URL}}/api/1/channel/phone/:identifier/","description":"

External-only convenience endpoint. Returns the first AccountChannel row on the current tenant whose identifier matches the path segment exactly. No status filter is applied — inactive or onboarding channels are returned if they match.

Endpoint

GET /api/1/channel/phone/{identifier}/\n\n

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Required	Description
`identifier`	Yes	Matched against `AccountChannel.identifier` exactly — case-sensitive, no normalization. URL-encode `+` as `+`. The URL regex limits this segment to characters other than `/` and `.`.

Request body

None.

Example request

GET /api/1/channel/phone/+393332224444/\nX-Spoki-Api-Key: {{Api-Key}}\n\n

Response — 200 OK

Full 10-field AccountChannel object.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Description
`id`	Primary key
`name`	Human-readable label
`identifier`	Phone number or channel identifier
`platform`	Platform code (see List channels for full table)
`status`	Activation status
`phone_status`	WhatsApp phone status code (see List channels for full table)
`quality_score`	WhatsApp quality score
`is_primary`	Whether this is the primary channel for its platform on this tenant
`waba`	WhatsApp Business Account ID
`auth_token`	Auth token (WhatsApp/Tyntec onboarding)

Example response

{\n  \"id\": 6,\n  \"name\": \"Main WhatsApp\",\n  \"identifier\": \"+393332224444\",\n  \"platform\": 1,\n  \"status\": 1,\n  \"phone_status\": \"CONNECTED\",\n  \"quality_score\": \"GREEN\",\n  \"is_primary\": true,\n  \"waba\": \"123456789012345\",\n  \"auth_token\": null\n}\n\n

Errors

\n\n\n\n\n\n\n\n\n\n\n\n\n

HTTP status	When
`404 Not Found`	No row on this tenant has that exact identifier.

The phone number (or other identifier) to look up. Must match AccountChannel.identifier exactly — case-sensitive, no normalization. URL-encode + as %2B. The URL segment regex excludes / and . characters.

\n","type":"text/plain"},"type":"any","value":"393332224444","key":"identifier"}]}},"response":[],"_postman_id":"d39f500a-7d26-465a-b8f5-20dbb5e4c9fa"}],"id":"aa2c6201-1794-43cc-97b0-4c90e082c920","description":"

Endpoints for managing messaging channels across all supported platforms (WhatsApp, SMS, Voice, and others).

This folder covers the full channel lifecycle:

List channels – Paginated, tenant-scoped list of all channels regardless of status.
Retrieve channel – Fetch a single channel by ID.
Create channel – Platform-aware creation: delegates to Tyntec onboarding for WhatsApp, triggers a profile-name review for SMS one-way, and performs a direct insert for all other platforms.
Rename channel – PATCH/PUT to update the channel name field.
Set primary channel – Promotes a channel to primary for its platform, automatically demoting any existing primary on the same account/platform pair.
Refresh WhatsApp phone status – Asynchronously re-pings the provider to update phone_status and quality_score; cached for 5 minutes.
Lookup channel by phone – External-facing lookup that returns the first channel matching a given phone identifier.

All endpoints are tenant-scoped. Cross-tenant access returns 404.

\n","_postman_id":"aa2c6201-1794-43cc-97b0-4c90e082c920","auth":{"type":"apikey","apikey":{"value":"{{Api-Key}}","key":""},"isInherited":true,"source":{"_postman_id":"b0f8e61f-7a2d-488c-8c5b-2835b092a3f9","id":"b0f8e61f-7a2d-488c-8c5b-2835b092a3f9","name":"Spoki API","type":"collection"}}}],"auth":{"type":"apikey","apikey":{"value":"{{Api-Key}}","key":""}},"event":[{"listen":"prerequest","script":{"id":"9b9d8765-d215-479f-bd3f-002caefa731c","type":"text/javascript","requests":{},"exec":[""]}},{"listen":"test","script":{"id":"9947b50b-a03f-4b86-91b8-ddd65ac9bf8b","type":"text/javascript","requests":{},"exec":[""]}}],"variable":[{"key":"webhook_uuid","value":"{{uuid}}"},{"key":"webhook_secret","value":"{{secret}}"},{"key":"id_account","value":"{{id}}"},{"key":"id_automation","value":"{{id}}"},{"key":"id_template","value":"{{id}}"},{"key":"id_list","value":"{{id}}"},{"key":"id_campaign","value":"{{id}}"},{"key":"id_contact","value":"{{id}}"},{"key":"id_custom_field","value":"{{id}}"},{"key":"id_ticket","value":"{{id}}"},{"key":"id_agency","value":"{{id}}"},{"key":"id_invitation","value":"{{id}}"},{"key":"id_role","value":"{{id}}"},{"key":"id_tag","value":"{{id}}"},{"key":"id_media","value":"{{id}}"},{"key":"first_name","value":"John"},{"key":"last_name","value":"Doe"},{"key":"email","value":"john.doe@domain.com"},{"key":"language","value":"en"},{"key":"list_name","value":"Newsletter"},{"key":"phone","value":"{{phone}}"},{"key":"id_webhook","value":"{{id}}"},{"key":"event_type","value":"{{event_type}}","description":"Possible values:\nchat.has_unread_messages\nmessage.outbound\nmessage.inbound\nmessage.note\ncontact.created\ncontact.updated\ncontact.deleted\ncontact_tag.created\ncontact_tag.deleted\ncontact_list.created\ncontact_list.deleted\ncontact_field.created_or_updated\ncontact_field.deleted\nform_answer.submitted\ntemplate.created\ntemplate.updated\ntemplate.deleted\nchannel.whatsapp.status\nchannel.sms_one_way.status\nchannel.sms_two_way.status"}]}