Campaigns

Test send campaign

Requires campaigns:manage and campaigns:read because the test can use stored recipient samples. Sends one copy of a draft campaign’s content to a seed recipient, through the same rendering, sending and BanSafe checks as a launched campaign. The seed recipient must be a number connected to your team. The sending number must be connected, on a plan that includes Campaigns and, when the campaign selects numbers, one of them. A test is not a campaign recipient and is not counted in the campaign’s statistics or webhooks. A team can send 20 tests an hour, and at most 5 an hour to one seed recipient. 429 means one of these limits was reached or BanSafe is pacing the sending number; follow Retry-After. 409 bansafe_cold_held means the seed recipient has never written to the sending number and the campaign holds first messages. 409 state_conflict means the campaign is not a draft or has A/B or weighted content alternatives, the sending number is a Hybrid Link number, or the seed recipient opted out. 504 result_unknown means the outcome was not received in time and the test may still arrive. Send projectId in the body when using a team API key. 422 campaign_variables_missing means the test’s sample values, the mapped recipient value and the fallback all leave a variable in the campaign content empty.

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

POST

platform

campaigns

{campaignId}

test-send

Test send campaign

curl --request POST \
  --url https://api.polymorfa.com/platform/campaigns/{campaignId}/test-send \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "sessionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "to": "+5511999990000"
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({sessionId: '3c90c3cc-0d44-4b50-8888-8dd25736052a', to: '+5511999990000'})
};

fetch('https://api.polymorfa.com/platform/campaigns/{campaignId}/test-send', 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}/test-send"

payload = {
    "sessionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "to": "+5511999990000"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

package main

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

func main() {

	url := "https://api.polymorfa.com/platform/campaigns/{campaignId}/test-send"

	payload := strings.NewReader("{\n  \"sessionId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"to\": \"+5511999990000\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "campaignId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "status": "sent",
    "from": {
      "sessionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "phone": "<string>"
    },
    "to": "<string>",
    "messageId": "<string>",
    "variables": {},
    "createdAt": 123
  }
}

{
  "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>"
}

{
  "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>"
}

{
  "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.

Headers

Idempotency-Key

string

Optional unique key, 1 to 255 bytes, that makes this request safe to retry for 24 hours. A retry with the same key, credential, Polymorfa-Version and request never runs it again: it returns 409 idempotency_completed when the original succeeded, or the original server error. Reusing the key for a different request returns 409 idempotency_conflict; a retry while the original is still running returns 409 idempotency_in_progress, and a retry after an unrecorded outcome returns 409 idempotency_outcome_unknown.

Value constraints

Constraint	Accepted input
String length	`1` through `255` characters

Required string length: 1 - 255

Path Parameters

campaignId

string

required

Identifier for the campaign.

Body

application/json

sessionId

string<uuid>

required

The number to send the test from. It must be connected, on a plan that includes Campaigns and, when the campaign selects numbers, one of them.

Value constraints

Constraint	Accepted input
Format	`uuid`

string

required

The seed recipient in international format. It must be the phone of a number connected to your team.

Value constraints

Constraint	Accepted input
String length	`1` through `32` characters

Required string length: 1 - 32

Example:

"+5511999990000"

projectId

string<uuid>

Required when using a team API key. Project tokens derive the project from the credential.

Value constraints

Constraint	Accepted input
Format	`uuid`

sampleRecipientId

string<uuid>

A recipient of this campaign whose variables fill the content. Without it and without variables, the campaign's first recipient, or its audience's first member, is the sample.

Value constraints

Constraint	Accepted input
Format	`uuid`

variables

object

Variable values for the test. They override the sample recipient's values; without sampleRecipientId, only these values are used.

Value constraints

Constraint	Accepted input
Object size	At most `50` properties

Show child attributes

Response

Success

data

object

required

Structured data carried by this object.

Show child attributes

Test send campaign

curl --request POST \
  --url https://api.polymorfa.com/platform/campaigns/{campaignId}/test-send \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "sessionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "to": "+5511999990000"
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({sessionId: '3c90c3cc-0d44-4b50-8888-8dd25736052a', to: '+5511999990000'})
};

fetch('https://api.polymorfa.com/platform/campaigns/{campaignId}/test-send', 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}/test-send"

payload = {
    "sessionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "to": "+5511999990000"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

package main

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

func main() {

	url := "https://api.polymorfa.com/platform/campaigns/{campaignId}/test-send"

	payload := strings.NewReader("{\n  \"sessionId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"to\": \"+5511999990000\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "campaignId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "status": "sent",
    "from": {
      "sessionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "phone": "<string>"
    },
    "to": "<string>",
    "messageId": "<string>",
    "variables": {},
    "createdAt": 123
  }
}

{
  "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>"
}

{
  "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>"
}

{
  "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

Test send campaign

Authorizations

Headers

Path Parameters

Body

Response