Campaigns

Update project campaign

Required scope: campaigns:manage

Updates the fields you send and leaves the rest unchanged. On an unlaunched draft, a new senderConfig passes the same checks as create, on any plan; launch checks the selection against live plans. Once the campaign has launched, including a scheduled launch that has not started, a new senderConfig must pass the launch checks and can answer 402 campaigns_not_entitled or 400 invalid_parameter. recipientListId and a different scheduledAt are accepted only while the campaign is an unlaunched draft; afterwards they answer 409. A sender change to a draft that launches while the change is being saved also answers 409. sendWindow changes only while draft or paused; a paused edit answers 409 while sends are in progress. A non-null scheduledAt must be integer Unix milliseconds within the JavaScript Date range.

PATCH

messaging

projects

{projectSlug}

campaigns

{id}

Update project campaign

curl --request PATCH \
  --url https://api.polymorfa.com/messaging/projects/{projectSlug}/campaigns/{id} \
  --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/messaging/projects/{projectSlug}/campaigns/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.polymorfa.com/messaging/projects/{projectSlug}/campaigns/{id}"

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/messaging/projects/{projectSlug}/campaigns/{id}"

	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))

}

{
  "success": true,
  "data": {
    "id": "<string>",
    "name": "<string>",
    "status": "<string>",
    "templateId": "<string>",
    "recipientListId": "<string>",
    "recipientCount": 123,
    "sentCount": 123,
    "deliveredCount": 123,
    "readCount": 123,
    "failedCount": 123,
    "skippedCount": 123,
    "scheduledAt": 123,
    "launchedAt": 123,
    "completedAt": 123,
    "createdAt": 123,
    "updatedAt": 123,
    "sendWindow": {
      "timeZone": "America/Sao_Paulo",
      "days": [
        "monday",
        "tuesday",
        "wednesday",
        "thursday",
        "friday"
      ],
      "hours": [
        {
          "start": "09:00",
          "end": "18:00"
        }
      ],
      "recipientTimeZone": true,
      "timeZoneVariable": "timeZone"
    }
  }
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "invalid_parameter",
    "message": "Correct the invalid request field.",
    "param": null,
    "request_id": "5f0c2a8e-3b1d-4c6f-9e2a-7d4b1c8f6a30"
  },
  "data": null,
  "docs": "https://docs.polymorfa.com/api/errors#invalid-parameter"
}

{
  "error": {
    "type": "authentication_error",
    "code": "invalid_credential",
    "message": "Supply a valid credential.",
    "param": null,
    "request_id": "5f0c2a8e-3b1d-4c6f-9e2a-7d4b1c8f6a30"
  },
  "data": null,
  "docs": "https://docs.polymorfa.com/api/errors#invalid-credential"
}

{
  "error": {
    "type": "permission_error",
    "code": "campaigns_not_entitled",
    "message": "This number’s plan does not include Campaigns.",
    "param": null,
    "request_id": "5f0c2a8e-3b1d-4c6f-9e2a-7d4b1c8f6a30"
  },
  "data": null,
  "docs": "https://docs.polymorfa.com/api/errors#campaigns-not-entitled"
}

{
  "error": {
    "type": "permission_error",
    "code": "permission_denied",
    "message": "The credential does not have access to this resource.",
    "param": null,
    "request_id": "5f0c2a8e-3b1d-4c6f-9e2a-7d4b1c8f6a30"
  },
  "data": null,
  "docs": "https://docs.polymorfa.com/api/errors#permission-denied"
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "resource_not_found",
    "message": "The resource is unavailable to this caller.",
    "param": null,
    "request_id": "5f0c2a8e-3b1d-4c6f-9e2a-7d4b1c8f6a30"
  },
  "data": null,
  "docs": "https://docs.polymorfa.com/api/errors#resource-not-found"
}

{
  "error": {
    "type": "conflict_error",
    "code": "state_conflict",
    "message": "The request conflicts with the resource state.",
    "param": null,
    "request_id": "5f0c2a8e-3b1d-4c6f-9e2a-7d4b1c8f6a30"
  },
  "data": null,
  "docs": "https://docs.polymorfa.com/api/errors#state-conflict"
}

{
  "error": {
    "type": "api_error",
    "code": "internal_error",
    "message": "An unexpected service failure occurred. Keep the request ID for support.",
    "param": null,
    "request_id": "5f0c2a8e-3b1d-4c6f-9e2a-7d4b1c8f6a30"
  },
  "data": null,
  "docs": "https://docs.polymorfa.com/api/errors#internal-error"
}

{
  "error": {
    "type": "api_error",
    "code": "service_unavailable",
    "message": "A required service is unavailable. Check completion before repeating a write.",
    "param": null,
    "request_id": "5f0c2a8e-3b1d-4c6f-9e2a-7d4b1c8f6a30"
  },
  "data": null,
  "docs": "https://docs.polymorfa.com/api/errors#service-unavailable"
}

Authorizations

Authorization

string

header

required

Polymorfa organization key (pmfa_ prefix), project token (pmfa_pt_ prefix) where supported, or short-lived client token (pmfa_ct_ prefix). Organization and project keys may be personal or service-account owned and enforce selected action scopes. Organization keys cover the team and its projects; project tokens stay inside one project. Client tokens stay inside their live project and session and enforce their client rules.

Path Parameters

projectSlug

string

required

Specifies project slug for this path parameter.

string<uuid>

required

Identifier for this resource.

Value constraints

Constraint	Accepted input
Format	`uuid`

Body

application/json

name

string

New name, 1 to 200 characters after trimming.

Value constraints

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

Required string length: 1 - 200

recipientListId

string<uuid> | null

Audience to send to, or null for none. Only an unlaunched draft can change it; the campaign's current recipients are replaced by the audience's members at launch.

Accepted alternatives

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

Value constraints

Constraint	Accepted input
Format	`uuid`

senderConfig

object

Replaces the sender selection and throughput. On an unlaunched draft it passes the same checks as create. Once the campaign has launched it must pass the launch checks.

Show child attributes

scheduledAt

integer | null

Start time in milliseconds since the Unix epoch, or null to start at launch. Only an unlaunched draft can change it.

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 · null

Specifies send window for this native update campaign request.

Accepted alternatives

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

Accepted alternatives

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

Show child attributes

Response

success

enum<boolean>

required

Whether the request succeeded.

Allowed values

Value	Meaning
`true`	True.

Available options:

true

data

object

required

Structured data carried by this object.

Show child attributes

Update project campaign

curl --request PATCH \
  --url https://api.polymorfa.com/messaging/projects/{projectSlug}/campaigns/{id} \
  --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/messaging/projects/{projectSlug}/campaigns/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.polymorfa.com/messaging/projects/{projectSlug}/campaigns/{id}"

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/messaging/projects/{projectSlug}/campaigns/{id}"

	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))

}

{
  "success": true,
  "data": {
    "id": "<string>",
    "name": "<string>",
    "status": "<string>",
    "templateId": "<string>",
    "recipientListId": "<string>",
    "recipientCount": 123,
    "sentCount": 123,
    "deliveredCount": 123,
    "readCount": 123,
    "failedCount": 123,
    "skippedCount": 123,
    "scheduledAt": 123,
    "launchedAt": 123,
    "completedAt": 123,
    "createdAt": 123,
    "updatedAt": 123,
    "sendWindow": {
      "timeZone": "America/Sao_Paulo",
      "days": [
        "monday",
        "tuesday",
        "wednesday",
        "thursday",
        "friday"
      ],
      "hours": [
        {
          "start": "09:00",
          "end": "18:00"
        }
      ],
      "recipientTimeZone": true,
      "timeZoneVariable": "timeZone"
    }
  }
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "invalid_parameter",
    "message": "Correct the invalid request field.",
    "param": null,
    "request_id": "5f0c2a8e-3b1d-4c6f-9e2a-7d4b1c8f6a30"
  },
  "data": null,
  "docs": "https://docs.polymorfa.com/api/errors#invalid-parameter"
}

{
  "error": {
    "type": "authentication_error",
    "code": "invalid_credential",
    "message": "Supply a valid credential.",
    "param": null,
    "request_id": "5f0c2a8e-3b1d-4c6f-9e2a-7d4b1c8f6a30"
  },
  "data": null,
  "docs": "https://docs.polymorfa.com/api/errors#invalid-credential"
}

{
  "error": {
    "type": "permission_error",
    "code": "campaigns_not_entitled",
    "message": "This number’s plan does not include Campaigns.",
    "param": null,
    "request_id": "5f0c2a8e-3b1d-4c6f-9e2a-7d4b1c8f6a30"
  },
  "data": null,
  "docs": "https://docs.polymorfa.com/api/errors#campaigns-not-entitled"
}

{
  "error": {
    "type": "permission_error",
    "code": "permission_denied",
    "message": "The credential does not have access to this resource.",
    "param": null,
    "request_id": "5f0c2a8e-3b1d-4c6f-9e2a-7d4b1c8f6a30"
  },
  "data": null,
  "docs": "https://docs.polymorfa.com/api/errors#permission-denied"
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "resource_not_found",
    "message": "The resource is unavailable to this caller.",
    "param": null,
    "request_id": "5f0c2a8e-3b1d-4c6f-9e2a-7d4b1c8f6a30"
  },
  "data": null,
  "docs": "https://docs.polymorfa.com/api/errors#resource-not-found"
}

{
  "error": {
    "type": "conflict_error",
    "code": "state_conflict",
    "message": "The request conflicts with the resource state.",
    "param": null,
    "request_id": "5f0c2a8e-3b1d-4c6f-9e2a-7d4b1c8f6a30"
  },
  "data": null,
  "docs": "https://docs.polymorfa.com/api/errors#state-conflict"
}

{
  "error": {
    "type": "api_error",
    "code": "internal_error",
    "message": "An unexpected service failure occurred. Keep the request ID for support.",
    "param": null,
    "request_id": "5f0c2a8e-3b1d-4c6f-9e2a-7d4b1c8f6a30"
  },
  "data": null,
  "docs": "https://docs.polymorfa.com/api/errors#internal-error"
}

{
  "error": {
    "type": "api_error",
    "code": "service_unavailable",
    "message": "A required service is unavailable. Check completion before repeating a write.",
    "param": null,
    "request_id": "5f0c2a8e-3b1d-4c6f-9e2a-7d4b1c8f6a30"
  },
  "data": null,
  "docs": "https://docs.polymorfa.com/api/errors#service-unavailable"
}

Overview

Messaging API

Platform API

Graph API

Webhook events

Update project campaign

Authorizations

Path Parameters

Body

Response