Bansafe

Update number safe mode

Sets one number’s Safe Mode. Each setting accepts inherit to follow the project ceiling. An override may only be equally or more conservative than the ceiling; a more visible value is refused with safe_mode_exceeds_project_ceiling. Raising a setting requires a plan that includes BanSafe Lite, and lowering one 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

sessions

{sessionId}

safe-mode

Update number safe mode

curl --request PUT \
  --url https://api.polymorfa.com/platform/sessions/{sessionId}/safe-mode \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{}'

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

fetch('https://api.polymorfa.com/platform/sessions/{sessionId}/safe-mode', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.polymorfa.com/platform/sessions/{sessionId}/safe-mode"

payload = {}
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/sessions/{sessionId}/safe-mode"

	payload := strings.NewReader("{}")

	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": {
    "session": "<string>",
    "projectId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "project": {
      "presence": "dark",
      "typing": "off",
      "reads": "off",
      "pacing": "off",
      "onlineStart": 11,
      "onlineEnd": 11
    },
    "override": {
      "presence": "inherit",
      "typing": "inherit",
      "reads": "inherit",
      "pacing": "inherit"
    },
    "effective": {
      "presence": "dark",
      "typing": "off",
      "reads": "off",
      "pacing": "off",
      "onlineStart": 11,
      "onlineEnd": 11
    },
    "applied": {
      "observedAt": "2023-11-07T05:31:56Z",
      "presence": "<string>",
      "typing": "<string>",
      "reads": "<string>",
      "pacing": "<string>"
    },
    "mismatch": true,
    "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

sessionId

string

required

Database session UUID or stable session slug.

Required string length: 1 - 64

Body

application/json

A partial update. inherit follows the project ceiling.

presence

enum<string>

Specifies presence for this management update session safe mode input.

Allowed values

Value	Meaning
`inherit`	Inherit.
`dark`	Dark.
`online_while_sending`	Online while sending.
`online_hours`	Online hours.

Available options:

inherit,

dark,

online_while_sending,

online_hours

typing

enum<string>

Specifies typing for this management update session safe mode input.

Allowed values

Value	Meaning
`inherit`	Inherit.
`off`	Off.
`before_text`	Before text.
`before_all`	Before all.

Available options:

inherit,

off,

before_text,

before_all

reads

enum<string>

Specifies reads for this management update session safe mode input.

Allowed values

Value	Meaning
`inherit`	Inherit.
`off`	Off.
`replied_chats`	Replied chats.
`all_inbound`	All inbound.

Available options:

inherit,

off,

replied_chats,

all_inbound

pacing

enum<string>

Specifies pacing for this management update session safe mode input.

Allowed values

Value	Meaning
`inherit`	Inherit.
`off`	Off.
`jittered`	Jittered.
`conversation`	Conversation.

Available options:

inherit,

off,

jittered,

conversation

Response

Success

data

object

required

Structured data carried by this object.

Show child attributes

⌘I

Update number safe mode

curl --request PUT \
  --url https://api.polymorfa.com/platform/sessions/{sessionId}/safe-mode \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{}'

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

fetch('https://api.polymorfa.com/platform/sessions/{sessionId}/safe-mode', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.polymorfa.com/platform/sessions/{sessionId}/safe-mode"

payload = {}
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/sessions/{sessionId}/safe-mode"

	payload := strings.NewReader("{}")

	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": {
    "session": "<string>",
    "projectId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "project": {
      "presence": "dark",
      "typing": "off",
      "reads": "off",
      "pacing": "off",
      "onlineStart": 11,
      "onlineEnd": 11
    },
    "override": {
      "presence": "inherit",
      "typing": "inherit",
      "reads": "inherit",
      "pacing": "inherit"
    },
    "effective": {
      "presence": "dark",
      "typing": "off",
      "reads": "off",
      "pacing": "off",
      "onlineStart": 11,
      "onlineEnd": 11
    },
    "applied": {
      "observedAt": "2023-11-07T05:31:56Z",
      "presence": "<string>",
      "typing": "<string>",
      "reads": "<string>",
      "pacing": "<string>"
    },
    "mismatch": true,
    "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 number safe mode

Authorizations

Path Parameters

Body

Response