Create project campaign

POST

messaging

projects

{projectSlug}

campaigns

Create project campaign

curl --request POST \
  --url https://api.polymorfa.com/messaging/projects/{projectSlug}/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/messaging/projects/{projectSlug}/campaigns', 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"

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/messaging/projects/{projectSlug}/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))

}

{
  "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": "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": "idempotency_conflict",
    "message": "This Idempotency-Key was already used with a different request. Use a new key for a different request.",
    "param": null
  },
  "data": null,
  "docs": "https://docs.polymorfa.com/api/errors#idempotency-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"
}

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.

Headers

Idempotency-Key

string

Unique key, 1 to 255 bytes of UTF-8, that makes this write safe to retry for 24 hours. A retry with the same key, credential, Polymorfa-Version, and request never runs the write again: it returns 409 idempotency_completed when the original succeeded, or the original server error, with Idempotent-Replayed: true. 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

projectSlug

string

required

Specifies project slug for this path parameter.

Body

application/json

name

string

required

Human-readable name for this resource.

Value constraints

Constraint	Accepted input
String length	At least `1` characters

Minimum string length: 1

templateId

string

Identifier of the message template.

recipientListId

string

Identifier for the recipient list.

senderConfig

object

Structured sender config values for this native create campaign request.

Show child attributes

scheduledAt

number

Unix timestamp in milliseconds when this operation is scheduled to start.

sendWindow

object · null · null

Specifies send window for this native create 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

recipients

object[]

Recipients to add inline, at most 1,000. Every entry must be valid or the campaign is not created; a repeated phone is kept once. Combine with recipientListId to add an audience at launch; add more with the add-recipients endpoint while the campaign is a draft.

Value constraints

Constraint	Accepted input
Array size	At most `1000` items

Maximum array length: 1000

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

Create project campaign

curl --request POST \
  --url https://api.polymorfa.com/messaging/projects/{projectSlug}/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/messaging/projects/{projectSlug}/campaigns', 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"

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/messaging/projects/{projectSlug}/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))

}

{
  "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": "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": "idempotency_conflict",
    "message": "This Idempotency-Key was already used with a different request. Use a new key for a different request.",
    "param": null
  },
  "data": null,
  "docs": "https://docs.polymorfa.com/api/errors#idempotency-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"
}

Overview

Messaging API

Platform API

Graph API

Webhook events

Create project campaign

Authorizations

Headers

Path Parameters

Body

Response