Opt-outs

Update stop confirmation settings

Replaces the team’s preference using the observed revision. Enabling requires STOP confirmations beta access and a selected locale. A team owner or admin can also change it in the console. A new STOP opt-out queues at most one plain acknowledgement from the receiving connection; manual opt-outs, repeated STOP while suppressed and START produce none. A confirmation cannot undo suppression. Disabling remains available after beta withdrawal and cancels queued acknowledgements. A changed revision returns 409. Unknown send outcomes are never resent with a new operation identity.

Requires a team API key with campaigns:manage. Project tokens are not accepted.

PUT

platform

optouts

confirmation-settings

Update stop confirmation settings

curl --request PUT \
  --url https://api.polymorfa.com/platform/optouts/confirmation-settings \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "teamId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "enabled": true,
  "revision": 1073741823
}
'

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    teamId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    enabled: true,
    revision: 1073741823
  })
};

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

import requests

url = "https://api.polymorfa.com/platform/optouts/confirmation-settings"

payload = {
    "teamId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "enabled": True,
    "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/optouts/confirmation-settings"

	payload := strings.NewReader("{\n  \"teamId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"enabled\": true,\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",
    "enabled": true,
    "locale": "en",
    "revision": 1,
    "textRevision": 1,
    "acknowledgement": "<string>",
    "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

teamId

string<uuid>

required

The teamId returned by the settings read. Must match the authenticated team.

Value constraints

Constraint	Accepted input
Format	`uuid`

enabled

boolean

required

Whether this feature is enabled.

locale

enum<string> | null

required

Required when enabled. Never inferred from a phone number.

Allowed values

Value	Meaning
`en`	En.
`pt-BR`	Pt br.
`es`	Es.
`null`	Null.

Accepted alternatives

Alternative	Accepted input
Alternative 1	Type: `string`; Value `en` or `pt-BR` or `es`
Alternative 2	`null`

Available options:

en,

pt-BR,

es,

null

revision

integer

required

Specifies revision for this management update stop confirmation settings input.

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 stop confirmation settings

curl --request PUT \
  --url https://api.polymorfa.com/platform/optouts/confirmation-settings \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "teamId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "enabled": true,
  "revision": 1073741823
}
'

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    teamId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    enabled: true,
    revision: 1073741823
  })
};

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

import requests

url = "https://api.polymorfa.com/platform/optouts/confirmation-settings"

payload = {
    "teamId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "enabled": True,
    "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/optouts/confirmation-settings"

	payload := strings.NewReader("{\n  \"teamId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"enabled\": true,\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",
    "enabled": true,
    "locale": "en",
    "revision": 1,
    "textRevision": 1,
    "acknowledgement": "<string>",
    "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 stop confirmation settings

Authorizations

Body

Response