Opt-outs

Update opt out settings

Replaces the team’s keyword opt-out settings. When enabled, a direct text reply whose whole body matches an opt-out keyword, from a number that received a campaign message from the team in the last 30 days, adds that number to the opt-out list with source stop-keyword and emits contact.opted_out. Matching ignores letter case and surrounding punctuation and whitespace. An opt-in keyword removes only an opt-out created this way and emits contact.opted_in; opt-outs added manually, by file or through the API are never removed by a reply. Each list holds at most 50 keywords of 1 to 32 characters, the opt-out list needs at least one keyword, and the two lists must not share a keyword. Keywords are stored in upper case. Changes apply to replies within 30 seconds.

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

PUT

platform

optouts

settings

Update opt out settings

curl --request PUT \
  --url https://api.polymorfa.com/platform/optouts/settings \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "enabled": true,
  "optOutKeywords": [
    "<string>"
  ],
  "optInKeywords": [
    "<string>"
  ]
}
'

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({enabled: true, optOutKeywords: ['<string>'], optInKeywords: ['<string>']})
};

fetch('https://api.polymorfa.com/platform/optouts/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/settings"

payload = {
    "enabled": True,
    "optOutKeywords": ["<string>"],
    "optInKeywords": ["<string>"]
}
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/settings"

	payload := strings.NewReader("{\n  \"enabled\": true,\n  \"optOutKeywords\": [\n    \"<string>\"\n  ],\n  \"optInKeywords\": [\n    \"<string>\"\n  ]\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": {
    "enabled": true,
    "optOutKeywords": [
      "<string>"
    ],
    "optInKeywords": [
      "<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>"
}

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

enabled

boolean

required

Whether this feature is enabled.

optOutKeywords

string[]

required

Opt out keywords associated with this management update opt out settings input.

Value constraints

Constraint	Accepted input
Array size	`1` through `50` items
Item string length	`1` through `32` characters

Required array length: 1 - 50 elements

Required string length: 1 - 32

optInKeywords

string[]

required

Opt in keywords associated with this management update opt out settings input.

Value constraints

Constraint	Accepted input
Array size	At most `50` items
Item string length	`1` through `32` characters

Maximum array length: 50

Required string length: 1 - 32

Response

Success

data

object

required

Structured data carried by this object.

Show child attributes

Update opt out settings

curl --request PUT \
  --url https://api.polymorfa.com/platform/optouts/settings \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "enabled": true,
  "optOutKeywords": [
    "<string>"
  ],
  "optInKeywords": [
    "<string>"
  ]
}
'

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({enabled: true, optOutKeywords: ['<string>'], optInKeywords: ['<string>']})
};

fetch('https://api.polymorfa.com/platform/optouts/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/settings"

payload = {
    "enabled": True,
    "optOutKeywords": ["<string>"],
    "optInKeywords": ["<string>"]
}
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/settings"

	payload := strings.NewReader("{\n  \"enabled\": true,\n  \"optOutKeywords\": [\n    \"<string>\"\n  ],\n  \"optInKeywords\": [\n    \"<string>\"\n  ]\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": {
    "enabled": true,
    "optOutKeywords": [
      "<string>"
    ],
    "optInKeywords": [
      "<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>"
}

Overview

Messaging API

Platform API

Graph API

Webhook events

Update opt out settings

Authorizations

Body

Response