Create an immediate or scheduled outbound WhatsApp send

curl --request POST \
  --url https://api-v2.watchcollect.com/v2/outbound/sends \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "session_id": "018f06e2-4f8d-7c01-8a0d-cc6fd78f7070",
  "group_ids": [
    "018f06e2-4f8d-7c01-8a0d-cc6fd78f7300"
  ],
  "idempotency_key": "frontend-outbound-018f06e2"
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    session_id: '018f06e2-4f8d-7c01-8a0d-cc6fd78f7070',
    group_ids: ['018f06e2-4f8d-7c01-8a0d-cc6fd78f7300'],
    idempotency_key: 'frontend-outbound-018f06e2'
  })
};

fetch('https://api-v2.watchcollect.com/v2/outbound/sends', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api-v2.watchcollect.com/v2/outbound/sends"

payload = {
    "session_id": "018f06e2-4f8d-7c01-8a0d-cc6fd78f7070",
    "group_ids": ["018f06e2-4f8d-7c01-8a0d-cc6fd78f7300"],
    "idempotency_key": "frontend-outbound-018f06e2"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "status": "accepted",
  "schedule": {
    "status": "accepted",
    "schedule_id": "018f06e2-4f8d-7c01-8a0d-cc6fd78f7200",
    "workflow_id": "outbound:text-send-schedule:018f06e2-4f8d-7c01-8a0d-cc6fd78f7200",
    "next_run_at_ms": 1777809600000,
    "interval_ms": 86400000,
    "max_occurrences": 5
  },
  "request_id": "018f06e2-4f8d-7c01-8a0d-cc6fd78f7001"
}

{
  "error": {
    "code": "invalid_payload",
    "message": "event is required",
    "request_id": "018f06e2-4f8d-7c01-8a0d-cc6fd78f7001"
  }
}

{
  "error": {
    "code": "invalid_payload",
    "message": "event is required",
    "request_id": "018f06e2-4f8d-7c01-8a0d-cc6fd78f7001"
  }
}

{
  "error": {
    "code": "invalid_payload",
    "message": "event is required",
    "request_id": "018f06e2-4f8d-7c01-8a0d-cc6fd78f7001"
  }
}

{
  "error": {
    "code": "invalid_payload",
    "message": "event is required",
    "request_id": "018f06e2-4f8d-7c01-8a0d-cc6fd78f7001"
  }
}

{
  "error": {
    "code": "invalid_payload",
    "message": "event is required",
    "request_id": "018f06e2-4f8d-7c01-8a0d-cc6fd78f7001"
  }
}

POST

outbound

sends

Create an immediate or scheduled outbound WhatsApp send

curl --request POST \
  --url https://api-v2.watchcollect.com/v2/outbound/sends \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "session_id": "018f06e2-4f8d-7c01-8a0d-cc6fd78f7070",
  "group_ids": [
    "018f06e2-4f8d-7c01-8a0d-cc6fd78f7300"
  ],
  "idempotency_key": "frontend-outbound-018f06e2"
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    session_id: '018f06e2-4f8d-7c01-8a0d-cc6fd78f7070',
    group_ids: ['018f06e2-4f8d-7c01-8a0d-cc6fd78f7300'],
    idempotency_key: 'frontend-outbound-018f06e2'
  })
};

fetch('https://api-v2.watchcollect.com/v2/outbound/sends', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api-v2.watchcollect.com/v2/outbound/sends"

payload = {
    "session_id": "018f06e2-4f8d-7c01-8a0d-cc6fd78f7070",
    "group_ids": ["018f06e2-4f8d-7c01-8a0d-cc6fd78f7300"],
    "idempotency_key": "frontend-outbound-018f06e2"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "status": "accepted",
  "schedule": {
    "status": "accepted",
    "schedule_id": "018f06e2-4f8d-7c01-8a0d-cc6fd78f7200",
    "workflow_id": "outbound:text-send-schedule:018f06e2-4f8d-7c01-8a0d-cc6fd78f7200",
    "next_run_at_ms": 1777809600000,
    "interval_ms": 86400000,
    "max_occurrences": 5
  },
  "request_id": "018f06e2-4f8d-7c01-8a0d-cc6fd78f7001"
}

{
  "error": {
    "code": "invalid_payload",
    "message": "event is required",
    "request_id": "018f06e2-4f8d-7c01-8a0d-cc6fd78f7001"
  }
}

{
  "error": {
    "code": "invalid_payload",
    "message": "event is required",
    "request_id": "018f06e2-4f8d-7c01-8a0d-cc6fd78f7001"
  }
}

{
  "error": {
    "code": "invalid_payload",
    "message": "event is required",
    "request_id": "018f06e2-4f8d-7c01-8a0d-cc6fd78f7001"
  }
}

{
  "error": {
    "code": "invalid_payload",
    "message": "event is required",
    "request_id": "018f06e2-4f8d-7c01-8a0d-cc6fd78f7001"
  }
}

{
  "error": {
    "code": "invalid_payload",
    "message": "event is required",
    "request_id": "018f06e2-4f8d-7c01-8a0d-cc6fd78f7001"
  }
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

session_id

string<uuid>

required

WORKING session id with can_send=true.

group_ids

string<uuid>[]

required

Internal group ids from /v2/groups that are present in the selected session.

Required array length: 1 - 100 elements

idempotency_key

string

required

Required string length: 1 - 200

text

string

Text body for a text send, or image caption when media is present. Required when media is omitted.

Maximum string length: 4096

media

object[]

Image media URLs to send with the message. At least text, media or multipart files must be provided.

Maximum array length: 10

Show child attributes

schedule

object

Show child attributes

Example:

{
  "first_run_at_ms": 1777809600000,
  "interval_ms": 3600000,
  "max_occurrences": 3
}

Response

Send command accepted.

status

enum<string>

required

Available options:

accepted,

duplicate_accepted

request_id

string

required

send

object

Show child attributes

Example:

{
  "status": "accepted",
  "send_id": "018f06e2-4f8d-7c01-8a0d-cc6fd78f7100",
  "event_ids": ["018f06e2-4f8d-7c01-8a0d-cc6fd78f7102"],
  "results": [
    {
      "recipient_send_id": "018f06e2-4f8d-7c01-8a0d-cc6fd78f7101",
      "group_id": "018f06e2-4f8d-7c01-8a0d-cc6fd78f7300",
      "ok": true,
      "status": "queued"
    }
  ],
  "request_id": "018f06e2-4f8d-7c01-8a0d-cc6fd78f7001"
}

schedule

object

Show child attributes

Introduction

Guides

API reference

Create an immediate or scheduled outbound WhatsApp send

Authorizations

Body

Response