Campaigns

Export campaign recipients

Returns recipients as CSV in queue order. Unfiltered exports page up to 1,000 recipients per request, using the Polymorfa-Next-Cursor response header. Each page starts with a header row and reflects outcomes when requested. Filtered exports are one atomic page of up to 1,000 recipients; larger filtered results return 409, so changing statuses cannot silently omit matches between pages. The export contains outcomes and failureReason codes only, never message content or template variables.

Requires campaigns:read. Project tokens only access resources in their own project.

GET

platform

campaigns

{campaignId}

recipients

export

Export campaign recipients

curl --request GET \
  --url https://api.polymorfa.com/platform/campaigns/{campaignId}/recipients/export \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.polymorfa.com/platform/campaigns/{campaignId}/recipients/export', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.polymorfa.com/platform/campaigns/{campaignId}/recipients/export"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

package main

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

func main() {

	url := "https://api.polymorfa.com/platform/campaigns/{campaignId}/recipients/export"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

<string>

{
  "error": {
    "type": "invalid_request_error",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "request_id": "<string>",
    "request_log_url": "<string>"
  },
  "data": null,
  "docs": "<string>"
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "request_id": "<string>",
    "request_log_url": "<string>"
  },
  "data": null,
  "docs": "<string>"
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "request_id": "<string>",
    "request_log_url": "<string>"
  },
  "data": null,
  "docs": "<string>"
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "request_id": "<string>",
    "request_log_url": "<string>"
  },
  "data": null,
  "docs": "<string>"
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "request_id": "<string>",
    "request_log_url": "<string>"
  },
  "data": null,
  "docs": "<string>"
}

Authorizations

Authorization

string

header

required

Send your team API key or project token as Authorization: Bearer <token>. The credential must have the required permissions. Project tokens can access only their own project.

Path Parameters

campaignId

string

required

Identifier for the campaign.

Query Parameters

projectId

string<uuid>

Project the campaign belongs to. Required with a team API key; a project token is bound to its own project and omits it.

Value constraints

Constraint	Accepted input
Format	`uuid`
Project that owns the campaign. Required for team API keys; a project token is bound to its own project.

status

enum<string>

Current status of this resource or operation.

Allowed values

Value	Meaning
`queued`	Queued.
`sending`	Sending.
`sent`	Sent.
`delivered`	Delivered.
`read`	Read.
`failed`	Failed.
`skipped`	Skipped.

Available options:

queued,

sending,

sent,

delivered,

read,

failed,

skipped

reason

enum<string>

Only recipients whose failureReason is this code.

Allowed values

Value	Meaning
`opted_out`	Opted out.
`cold_held`	Cold held.
`campaign_cancelled`	Campaign cancelled.
`invalid_recipient`	Invalid recipient.
`session_not_connected`	Session not connected.
`ack_timeout`	Ack timeout.
`blocked_by_safety`	Blocked by safety.
`send_failed`	Send failed.
`missing_variable`	Missing variable.
`other`	Other.
Why the recipient was not sent, or why its last attempt did not succeed. Null when nothing went wrong. `opted_out`: the number is on the team's opt-out list. `cold_held`: the number never wrote to the sending number and the campaign holds cold sends. `campaign_cancelled`: the campaign was stopped before this recipient was sent. `invalid_recipient`: the number is not a valid WhatsApp address. `session_not_connected`: the sending number was not connected. `ack_timeout`: WhatsApp did not acknowledge the send in time. `blocked_by_safety`: a safety check refused the send before it was attempted; the recipient waits for the campaign to resume. `send_failed`: WhatsApp refused the send, or its outcome could not be confirmed. `missing_variable`: the campaign was launched with `skipMissingVariables` and the recipient had no value and no fallback for a variable. `other`: any other reason. New codes may be added.

Available options:

opted_out,

cold_held,

campaign_cancelled,

invalid_recipient,

session_not_connected,

ack_timeout,

blocked_by_safety,

send_failed,

missing_variable,

other

cursor

string

Specifies cursor for this query parameter.

Value constraints

Constraint	Accepted input
String length	`1` through `256` characters
The `Polymorfa-Next-Cursor` value from the previous unfiltered page. Filtered exports cannot be paged.

Required string length: 1 - 256

limit

integer

default:1000

Specifies limit for this query parameter.

Value constraints

Constraint	Accepted input
Numeric value	`1` through `1000` (inclusive)
Recipients per unfiltered page, up to 1,000. Filtered exports require 1,000.

Required range: 1 <= x <= 1000

Response

One CSV page.

Header row, then one row per recipient. Columns: recipientId, phone, status, failureReason, attempts, variantKey, queuedAt, sentAt, deliveredAt, readAt, failedAt, respondedAt. Times are ISO 8601 in UTC. Empty fields are null. Text that begins with =, +, -, @, tab or carriage return is prefixed with an apostrophe, including phone numbers in international format. Machine readers should remove that leading apostrophe from phone cells.

Export campaign recipients

curl --request GET \
  --url https://api.polymorfa.com/platform/campaigns/{campaignId}/recipients/export \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.polymorfa.com/platform/campaigns/{campaignId}/recipients/export', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.polymorfa.com/platform/campaigns/{campaignId}/recipients/export"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

package main

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

func main() {

	url := "https://api.polymorfa.com/platform/campaigns/{campaignId}/recipients/export"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

<string>

{
  "error": {
    "type": "invalid_request_error",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "request_id": "<string>",
    "request_log_url": "<string>"
  },
  "data": null,
  "docs": "<string>"
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "request_id": "<string>",
    "request_log_url": "<string>"
  },
  "data": null,
  "docs": "<string>"
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "request_id": "<string>",
    "request_log_url": "<string>"
  },
  "data": null,
  "docs": "<string>"
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "request_id": "<string>",
    "request_log_url": "<string>"
  },
  "data": null,
  "docs": "<string>"
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "request_id": "<string>",
    "request_log_url": "<string>"
  },
  "data": null,
  "docs": "<string>"
}

Overview

Messaging API

Platform API

Graph API

Webhook events

Export campaign recipients

Authorizations

Path Parameters

Query Parameters

Response