Campaigns

Update campaign

Updates a campaign. On an unlaunched draft, a new senderConfig passes the same checks as create and plans are checked at launch. Once the campaign has launched, including a scheduled launch that has not started, a new senderConfig passes the launch checks and can answer 402 campaigns_not_entitled or 400 invalid_parameter. recipientListId points the campaign at another audience while it is still an unlaunched draft and replaces its existing recipients; after launch it answers 409. A sender edit to a draft that launches while the edit is being saved also answers 409. A changed scheduledAt after launch answers 409; use reschedule to move a scheduled start. A non-null scheduledAt must be integer Unix milliseconds from zero through the JavaScript Date maximum. sendWindow changes only while the campaign is a draft or paused; a running campaign answers 409, so pause it first. An edit to a paused campaign also answers 409 while sends are in progress; retry after they settle. A stalled send that has not reached the provider can be recovered on a later edit attempt. If delivery may have started, the edit waits for a definite result rather than sending the recipient again. A new window applies to the remaining recipients when the campaign resumes.

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

PATCH

platform

campaigns

{campaignId}

Update campaign

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

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

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

payload = {}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(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}"

	payload := strings.NewReader("{}")

	req, _ := http.NewRequest("PATCH", 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>"
}

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

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

Body

application/json

Fields to change. Omitted fields keep their stored value.

name

string

Human-readable name for this resource.

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`

recipientListId

string<uuid> | null

Audience to send to. Only while the campaign is an unlaunched draft.

Accepted alternatives

Alternative	Accepted input
Alternative 1	Type: `string`; Format: `uuid`
Alternative 2	`null`

Value constraints

Constraint	Accepted input
Format	`uuid`

senderConfig

object

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

scheduledAt

integer | null

Scheduled start time in Unix milliseconds. Only while the campaign is an unlaunched draft.

Accepted alternatives

Alternative	Accepted input
Alternative 1	Type: `integer`; Numeric value: `0` through `8640000000000000` (inclusive)
Alternative 2	`null`

Value constraints

Constraint	Accepted input
Numeric value	`0` through `8640000000000000` (inclusive)

Required range: 0 <= x <= 8640000000000000

sendWindow

object | null

When the campaign may send. null removes the window. Only while the campaign is a draft or paused.

Accepted alternatives

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

Show child attributes

Response

Success

data

object

required

Structured data carried by this object.

Show child attributes

Update campaign

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

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

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

payload = {}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(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}"

	payload := strings.NewReader("{}")

	req, _ := http.NewRequest("PATCH", 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>"
}

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

Update campaign

Authorizations

Path Parameters

Query Parameters

Body

Response