Send a test WhatsApp message or collection

POST /whatsapp/test-send

Send a test WhatsApp message or collection

cURL

curl --request POST \
  --url https://api.pineyard.ai/whatsapp/test-send \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --data '
{
  "toPhone": "<string>"
}
'

202

{
  "messages": [
    {
      "id": "<string>",
      "direction": "OUTBOUND",
      "toPhone": "<string>",
      "type": "TEXT",
      "body": "<string>",
      "status": "QUEUED",
      "providerMsgId": "<string>",
      "mediaItemId": "<string>",
      "collectionId": "<string>",
      "callId": "<string>",
      "campaignId": "<string>",
      "error": "<string>",
      "createdAt": "<string>",
      "sentAt": "<string>",
      "deliveredAt": "<string>",
      "readAt": "<string>",
      "templateId": "<string>",
      "providerErrorReason": "<string>",
      "failureReason": "<string>",
      "templateValues": {
        "headerValues": [
          "<string>"
        ],
        "bodyValues": [
          "<string>"
        ],
        "name": "<string>",
        "templatePurpose": "<string>",
        "fileName": "<string>"
      },
      "conversationId": "<string>",
      "contactId": "<string>",
      "campaignContactId": "<string>",
      "hasMedia": true,
      "mediaMimeType": "<string>",
      "mediaFileName": "<string>"
    }
  ]
}

Required scope: whatsapp.send

Idempotency: an Idempotency-Key header is required when calling with an API key. See Idempotency.

Authorizations

Authorization · string · header · required

Your API key, e.g. pk_live_xxxxxxxxxxxxxxxxxxxxxxxx.

Headers

Idempotency-Key · string · required

Unique value (e.g. a UUID) per action, up to 200 printable ASCII characters. Reuse it only to retry the same request; the first response is replayed for 24 hours.

Maximum string length: 200

Example:

"f1d2c3b4-0000-4000-8000-000000000000"

Body

application/json

toPhone · string · required

Required string length: 3 - 32

senderId · string

body · string

Maximum string length: 4096

collectionId · string

templateId · string

callId · string

campaignId · string

Response

202

application/json

Queued

messages · object[] · required

Show child attributes