Campaign Settings

Update campaign frequency cap

Replaces the team’s contact frequency cap using the revision you read; a changed revision answers 409. Send null for a window to remove its limit, or both null to remove the cap. Setting a limit requires the contact frequency caps beta and otherwise answers 403 feature_unavailable; removing the cap does not. Requires a team API key or a signed-in team owner or admin; project tokens answer 403. A message over the cap is skipped with frequency_cap_exceeded; a later sequence message stops that recipient’s remaining sequence. Settled skips are never retried when a cap changes.

API keys require campaigns:manage. Project tokens are not accepted.

PUT

platform

campaign-settings

frequency-cap

Update campaign frequency cap

curl --request PUT \
  --url https://api.polymorfa.com/platform/campaign-settings/frequency-cap \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "maxPer24Hours": 25,
  "maxPer7Days": 100,
  "revision": 1073741823
}
'

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({maxPer24Hours: 25, maxPer7Days: 100, revision: 1073741823})
};

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

import requests

url = "https://api.polymorfa.com/platform/campaign-settings/frequency-cap"

payload = {
    "maxPer24Hours": 25,
    "maxPer7Days": 100,
    "revision": 1073741823
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

package main

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

func main() {

	url := "https://api.polymorfa.com/platform/campaign-settings/frequency-cap"

	payload := strings.NewReader("{\n  \"maxPer24Hours\": 25,\n  \"maxPer7Days\": 100,\n  \"revision\": 1073741823\n}")

	req, _ := http.NewRequest("PUT", 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": {
    "teamId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "maxPer24Hours": 25,
    "maxPer7Days": 100,
    "revision": 1,
    "updatedAt": 123
  }
}

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

maxPer24Hours

integer | null

required

Most campaign messages one phone number receives from the team in any rolling 24 hours, 1 to 50. null sets no 24-hour limit.

Accepted alternatives

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

Value constraints

Constraint	Accepted input
Numeric value	`1` through `50` (inclusive)

Required range: 1 <= x <= 50

maxPer7Days

integer | null

required

Most campaign messages one phone number receives from the team in any rolling 7 days, 1 to 200. null sets no 7-day limit. Must not be lower than maxPer24Hours.

Accepted alternatives

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

Value constraints

Constraint	Accepted input
Numeric value	`1` through `200` (inclusive)

Required range: 1 <= x <= 200

revision

integer

required

The revision from your last read.

Value constraints

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

Required range: 0 <= x <= 2147483646

Response

Success

data

object

required

Structured data carried by this object.

Show child attributes

Update campaign frequency cap

curl --request PUT \
  --url https://api.polymorfa.com/platform/campaign-settings/frequency-cap \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "maxPer24Hours": 25,
  "maxPer7Days": 100,
  "revision": 1073741823
}
'

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({maxPer24Hours: 25, maxPer7Days: 100, revision: 1073741823})
};

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

import requests

url = "https://api.polymorfa.com/platform/campaign-settings/frequency-cap"

payload = {
    "maxPer24Hours": 25,
    "maxPer7Days": 100,
    "revision": 1073741823
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

package main

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

func main() {

	url := "https://api.polymorfa.com/platform/campaign-settings/frequency-cap"

	payload := strings.NewReader("{\n  \"maxPer24Hours\": 25,\n  \"maxPer7Days\": 100,\n  \"revision\": 1073741823\n}")

	req, _ := http.NewRequest("PUT", 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": {
    "teamId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "maxPer24Hours": 25,
    "maxPer7Days": 100,
    "revision": 1,
    "updatedAt": 123
  }
}

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

Authorizations

Body

Response