Campaigns

Create campaign

Creates a draft campaign on any plan. senderConfig.sessionIds may name numbers that are not yet on a plan that includes Campaigns; launch checks the selection. It is refused with 403 bansafe_org_suspended while the team is suspended, 400 invalid_parameter when senderConfig.sessionIds is malformed, and 400 campaign_throughput_capped when a per-number cap is above its safety ceiling.

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

POST

platform

campaigns

Create campaign

curl --request POST \
  --url https://api.polymorfa.com/platform/campaigns \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>"
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({name: '<string>'})
};

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

import requests

url = "https://api.polymorfa.com/platform/campaigns"

payload = { "name": "<string>" }
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"

	payload := strings.NewReader("{\n  \"name\": \"<string>\"\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>",
    "status": "<string>",
    "templateId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "recipientListId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "recipientCount": 1,
    "sentCount": 1,
    "deliveredCount": 1,
    "readCount": 1,
    "failedCount": 1,
    "skippedCount": 1,
    "scheduledAt": 123,
    "launchedAt": 123,
    "completedAt": 123,
    "createdAt": 123,
    "updatedAt": 123,
    "sendWindow": {
      "timeZone": "<string>",
      "days": [
        "monday"
      ],
      "hours": [
        {
          "start": "09:00",
          "end": "18:00"
        }
      ],
      "recipientTimeZone": true,
      "timeZoneVariable": "<string>"
    },
    "composerBlueprint": "<unknown>",
    "messages": "<unknown>",
    "audienceRef": "<unknown>",
    "senderConfig": "<unknown>",
    "complianceConfig": "<unknown>",
    "variants": "<unknown>",
    "variantStrategy": "<unknown>"
  }
}

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

Campaign name, trimmed before validation. Must not be blank.

Value constraints

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

Required string length: 1 - 200

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`

templateId

string<uuid>

Identifier of the message template.

Value constraints

Constraint	Accepted input
Format	`uuid`

recipientListId

string<uuid>

Audience in the same team whose members are copied when the campaign launches.

Value constraints

Constraint	Accepted input
Format	`uuid`

senderConfig

object

Structured sender config values for this management create platform campaign request.

scheduledAt

number

Scheduled start time in Unix milliseconds.

sendWindow

object | null

Specifies send window for this management create platform campaign request.

Accepted alternatives

Alternative	Accepted input
Alternative 1	Type: `object`; Required fields: `days`, `hours`
Alternative 2	`null`

Show child attributes

recipients

object[]

At most 1,000 recipients per request.

Value constraints

Constraint	Accepted input
Array size	`0` through `1000` items

Maximum array length: 1000

Show child attributes

recipientCount

number

Ignored when inline recipients are provided; their stored count is authoritative.

composerBlueprint

any

Specifies composer blueprint for this management create platform campaign request.

messagesArray

any

Specifies messages array for this management create platform campaign request.

audienceRef

any

Specifies audience ref for this management create platform campaign request.

complianceConfig

any

Specifies compliance config for this management create platform campaign request.

variants

any

Specifies variants for this management create platform campaign request.

variantStrategy

any

Specifies variant strategy for this management create platform campaign request.

Response

Success

data

object

required

Structured data carried by this object.

Show child attributes

Create campaign

curl --request POST \
  --url https://api.polymorfa.com/platform/campaigns \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>"
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({name: '<string>'})
};

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

import requests

url = "https://api.polymorfa.com/platform/campaigns"

payload = { "name": "<string>" }
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"

	payload := strings.NewReader("{\n  \"name\": \"<string>\"\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>",
    "status": "<string>",
    "templateId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "recipientListId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "recipientCount": 1,
    "sentCount": 1,
    "deliveredCount": 1,
    "readCount": 1,
    "failedCount": 1,
    "skippedCount": 1,
    "scheduledAt": 123,
    "launchedAt": 123,
    "completedAt": 123,
    "createdAt": 123,
    "updatedAt": 123,
    "sendWindow": {
      "timeZone": "<string>",
      "days": [
        "monday"
      ],
      "hours": [
        {
          "start": "09:00",
          "end": "18:00"
        }
      ],
      "recipientTimeZone": true,
      "timeZoneVariable": "<string>"
    },
    "composerBlueprint": "<unknown>",
    "messages": "<unknown>",
    "audienceRef": "<unknown>",
    "senderConfig": "<unknown>",
    "complianceConfig": "<unknown>",
    "variants": "<unknown>",
    "variantStrategy": "<unknown>"
  }
}

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

Authorizations

Body

Response