Bansafe

Update project warmup plan settings

Turns the warm-up plan on or off for a project and sets how long the ramp takes and how many messages a number may send on its first day. Send only the settings you want to change. While the plan is on, a send past a number’s allowance is refused with bansafe_daily_allowance_reached and campaign recipients are deferred to the next reset. Turning the plan on requires a plan that includes BanSafe Lite; turning it off is always allowed. A signed-in caller must be an organization owner, admin, or developer.

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

PUT

platform

projects

{projectId}

warmup-plan

Update project warmup plan settings

curl --request PUT \
  --url https://api.polymorfa.com/platform/projects/{projectId}/warmup-plan \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "enabled": true,
  "warmupDays": 45,
  "dailyStart": 1000
}
'

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({enabled: true, warmupDays: 45, dailyStart: 1000})
};

fetch('https://api.polymorfa.com/platform/projects/{projectId}/warmup-plan', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.polymorfa.com/platform/projects/{projectId}/warmup-plan"

payload = {
    "enabled": True,
    "warmupDays": 45,
    "dailyStart": 1000
}
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/projects/{projectId}/warmup-plan"

	payload := strings.NewReader("{\n  \"enabled\": true,\n  \"warmupDays\": 45,\n  \"dailyStart\": 1000\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": {
    "projectId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "plan": {
      "enabled": true,
      "warmupDays": 45,
      "dailyStart": 1000
    },
    "ceiling": 2,
    "curve": [
      {
        "day": 1,
        "allowance": 1
      }
    ],
    "entitled": true,
    "entitlementReason": "<string>"
  }
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>"
  },
  "data": null,
  "docs": "<string>"
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>"
  },
  "data": null,
  "docs": "<string>"
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>"
  },
  "data": null,
  "docs": "<string>"
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>"
  },
  "data": null,
  "docs": "<string>"
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>"
  },
  "data": null,
  "docs": "<string>"
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>"
  },
  "data": null,
  "docs": "<string>"
}

Authorizations

Authorization

string

header

required

Polymorfa server credential: a scoped pmfa_ organization key, or a pmfa_pt_ project token on project- and session-bound operations inside its exact authenticated project. Keys may be personal or service-account owned. Both enforce selected action scopes; organization keys can address team resources and every project in the organization. Listener and browser client credentials are rejected.

Path Parameters

projectId

string<uuid>

required

Identifier of the Polymorfa project that owns this resource.

Value constraints

Constraint	Accepted input
Format	`uuid`

Body

application/json

A partial update: send only the settings you want to change.

enabled

boolean

Whether this feature is enabled.

warmupDays

integer

Specifies warmup days for this management update project warmup plan input.

Value constraints

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

Required range: 1 <= x <= 90

dailyStart

integer

Specifies daily start for this management update project warmup plan input.

Value constraints

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

Required range: 1 <= x <= 2000

Response

Success

data

object

required

Structured data carried by this object.

Show child attributes

⌘I

Update project warmup plan settings

curl --request PUT \
  --url https://api.polymorfa.com/platform/projects/{projectId}/warmup-plan \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "enabled": true,
  "warmupDays": 45,
  "dailyStart": 1000
}
'

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({enabled: true, warmupDays: 45, dailyStart: 1000})
};

fetch('https://api.polymorfa.com/platform/projects/{projectId}/warmup-plan', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.polymorfa.com/platform/projects/{projectId}/warmup-plan"

payload = {
    "enabled": True,
    "warmupDays": 45,
    "dailyStart": 1000
}
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/projects/{projectId}/warmup-plan"

	payload := strings.NewReader("{\n  \"enabled\": true,\n  \"warmupDays\": 45,\n  \"dailyStart\": 1000\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": {
    "projectId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "plan": {
      "enabled": true,
      "warmupDays": 45,
      "dailyStart": 1000
    },
    "ceiling": 2,
    "curve": [
      {
        "day": 1,
        "allowance": 1
      }
    ],
    "entitled": true,
    "entitlementReason": "<string>"
  }
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>"
  },
  "data": null,
  "docs": "<string>"
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>"
  },
  "data": null,
  "docs": "<string>"
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>"
  },
  "data": null,
  "docs": "<string>"
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>"
  },
  "data": null,
  "docs": "<string>"
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>"
  },
  "data": null,
  "docs": "<string>"
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>"
  },
  "data": null,
  "docs": "<string>"
}

Overview

Messaging API

Platform API

Graph API

Webhook events

Update project warmup plan settings

Authorizations

Path Parameters

Body

Response