Audiences

Create audience from campaign

Creates an audience from the recipients of a previous campaign that had one outcome, to send them a follow-up campaign. The members are a snapshot taken when the request runs: later receipts, reads or replies on the source campaign do not change the audience. Numbers on the team’s opt-out list are left out and counted in optedOutCount; each member keeps the template variables it had on the source campaign. Outcomes: delivered (the device confirmed delivery), not_delivered (sent, with no delivery confirmation), read, not_read (sent and not read, including sends never delivered), replied, not_replied (sent and no reply was attributed), and failed (confirmed failed sends; sends whose outcome is uncertain, such as a timeout waiting for WhatsApp, are excluded). Read outcomes depend on the recipient’s read receipts. 404 means the campaign is not in your team (or not in projectId when given); 409 means no recipient that is not opted out has the outcome, and nothing is created.

Requires a team API key with campaigns:manage. Project tokens are not accepted.

POST

platform

audiences

from-campaign

Create audience from campaign

curl --request POST \
  --url https://api.polymorfa.com/platform/audiences/from-campaign \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "campaignId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'

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

fetch('https://api.polymorfa.com/platform/audiences/from-campaign', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.polymorfa.com/platform/audiences/from-campaign"

payload = {
    "name": "<string>",
    "campaignId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
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/audiences/from-campaign"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"campaignId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\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",
    "name": "<string>",
    "source": "campaign",
    "recipientCount": 1,
    "fileId": "<string>",
    "columns": [
      "<string>"
    ],
    "sampleRow": {},
    "mapping": {},
    "createdAt": 123,
    "updatedAt": 123,
    "sourceCampaignId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "outcome": "delivered",
    "matchedCount": 1,
    "optedOutCount": 1
  }
}

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

Body

application/json

name

string

required

Human-readable name for this resource.

Value constraints

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

Required string length: 1 - 200

campaignId

string<uuid>

required

The campaign whose recipients are selected.

Value constraints

Constraint	Accepted input
Format	`uuid`

outcome

enum<string>

required

Specifies outcome for this schema.

Allowed values

Value	Meaning
`delivered`	Delivered.
`not_delivered`	Not delivered.
`read`	Read.
`not_read`	Not read.
`replied`	Replied.
`not_replied`	Not replied.
`failed`	Failed.

Available options:

delivered,

not_delivered,

read,

not_read,

replied,

not_replied,

failed

projectId

string<uuid>

Optional. When given, the campaign must belong to this project.

Value constraints

Constraint	Accepted input
Format	`uuid`

Response

Success

data

object

required

Structured data carried by this object.

Show child attributes

Create audience from campaign

curl --request POST \
  --url https://api.polymorfa.com/platform/audiences/from-campaign \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "campaignId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'

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

fetch('https://api.polymorfa.com/platform/audiences/from-campaign', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.polymorfa.com/platform/audiences/from-campaign"

payload = {
    "name": "<string>",
    "campaignId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
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/audiences/from-campaign"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"campaignId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\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",
    "name": "<string>",
    "source": "campaign",
    "recipientCount": 1,
    "fileId": "<string>",
    "columns": [
      "<string>"
    ],
    "sampleRow": {},
    "mapping": {},
    "createdAt": 123,
    "updatedAt": 123,
    "sourceCampaignId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "outcome": "delivered",
    "matchedCount": 1,
    "optedOutCount": 1
  }
}

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

Create audience from campaign

Authorizations

Body

Response