Bansafe

Update project safe mode ceiling

Sets the most visible behaviour any number in this project may use. Send only the settings you want to change. Presence and read receipts are visible to the people these numbers message: turning them on makes a number appear online, exposes last seen subject to the account’s privacy settings, and puts blue ticks on incoming messages. 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

projects

{projectId}

safe-mode

Update project safe mode ceiling

curl --request PUT \
  --url https://api.polymorfa.com/platform/projects/{projectId}/safe-mode \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "onlineStart": 11,
  "onlineEnd": 11
}
'

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

fetch('https://api.polymorfa.com/platform/projects/{projectId}/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/projects/{projectId}/safe-mode"

payload = {
    "onlineStart": 11,
    "onlineEnd": 11
}
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}/safe-mode"

	payload := strings.NewReader("{\n  \"onlineStart\": 11,\n  \"onlineEnd\": 11\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",
    "ceiling": {
      "presence": "dark",
      "typing": "off",
      "reads": "off",
      "pacing": "off",
      "onlineStart": 11,
      "onlineEnd": 11
    },
    "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.

presence

enum<string>

Specifies presence for this management update project safe mode input.

Allowed values

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

Available options:

dark,

online_while_sending,

online_hours

typing

enum<string>

Specifies typing for this management update project safe mode input.

Allowed values

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

Available options:

off,

before_text,

before_all

reads

enum<string>

Specifies reads for this management update project safe mode input.

Allowed values

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

Available options:

off,

replied_chats,

all_inbound

pacing

enum<string>

Specifies pacing for this management update project safe mode input.

Allowed values

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

Available options:

off,

jittered,

conversation

onlineStart

integer

Specifies online start for this management update project safe mode input.

Value constraints

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

Required range: 0 <= x <= 23

onlineEnd

integer

Specifies online end for this management update project safe mode input.

Value constraints

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

Required range: 0 <= x <= 23

Response

Success

data

object

required

Structured data carried by this object.

Show child attributes

⌘I

Update project safe mode ceiling

curl --request PUT \
  --url https://api.polymorfa.com/platform/projects/{projectId}/safe-mode \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "onlineStart": 11,
  "onlineEnd": 11
}
'

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

fetch('https://api.polymorfa.com/platform/projects/{projectId}/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/projects/{projectId}/safe-mode"

payload = {
    "onlineStart": 11,
    "onlineEnd": 11
}
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}/safe-mode"

	payload := strings.NewReader("{\n  \"onlineStart\": 11,\n  \"onlineEnd\": 11\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",
    "ceiling": {
      "presence": "dark",
      "typing": "off",
      "reads": "off",
      "pacing": "off",
      "onlineStart": 11,
      "onlineEnd": 11
    },
    "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 safe mode ceiling

Authorizations

Path Parameters

Body

Response