Campaigns

List campaign launch approvals

Lists a campaign’s approval requests, newest first, at most 20. A request is created when a launch is held by the team’s approval threshold, or when an AI agent asks through the hosted MCP server to launch, resume or move the start (reasons says which). action is the requested step. It records the frozen recipient count and the requested start time. status is pending until a team owner or admin approves or rejects it, superseded when a later launch request or a change to the campaign replaced it, and expired 72 hours after it was requested.

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

GET

platform

campaigns

{campaignId}

approvals

List campaign launch approvals

curl --request GET \
  --url https://api.polymorfa.com/platform/campaigns/{campaignId}/approvals \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

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

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.polymorfa.com/platform/campaigns/{campaignId}/approvals"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	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",
      "campaignId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "action": "launch",
      "status": "pending",
      "reasons": [
        "audience_threshold"
      ],
      "recipientCount": 1,
      "scheduledAt": 123,
      "requestedBy": {
        "type": "<string>",
        "id": "<string>"
      },
      "requestedAt": 123,
      "expiresAt": 123,
      "decidedBy": "<string>",
      "decidedAt": 123,
      "operationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    }
  ]
}

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

Response

Success

data

object[]

required

Structured data carried by this object.

Show child attributes

List campaign launch approvals

curl --request GET \
  --url https://api.polymorfa.com/platform/campaigns/{campaignId}/approvals \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

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

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.polymorfa.com/platform/campaigns/{campaignId}/approvals"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	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",
      "campaignId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "action": "launch",
      "status": "pending",
      "reasons": [
        "audience_threshold"
      ],
      "recipientCount": 1,
      "scheduledAt": 123,
      "requestedBy": {
        "type": "<string>",
        "id": "<string>"
      },
      "requestedAt": 123,
      "expiresAt": 123,
      "decidedBy": "<string>",
      "decidedAt": 123,
      "operationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    }
  ]
}

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

List campaign launch approvals

Authorizations

Path Parameters

Query Parameters

Response