Set client rules

PUT

platform

sessions

{session}

client-rules

Set client rules

curl --request PUT \
  --url https://api.polymorfa.com/platform/sessions/{session}/client-rules \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "recipientMode": "<string>",
  "enabled": true
}
'

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

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

import requests

url = "https://api.polymorfa.com/platform/sessions/{session}/client-rules"

payload = {
    "recipientMode": "<string>",
    "enabled": True
}
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/{session}/client-rules"

	payload := strings.NewReader("{\n  \"recipientMode\": \"<string>\",\n  \"enabled\": true\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))

}

{
  "success": true,
  "message": "<string>"
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "invalid_parameter",
    "message": "Correct the invalid request field.",
    "param": null,
    "request_id": "5f0c2a8e-3b1d-4c6f-9e2a-7d4b1c8f6a30"
  },
  "data": null,
  "docs": "https://docs.polymorfa.com/api/errors#invalid-parameter"
}

{
  "error": {
    "type": "authentication_error",
    "code": "invalid_credential",
    "message": "Supply a valid credential.",
    "param": null,
    "request_id": "5f0c2a8e-3b1d-4c6f-9e2a-7d4b1c8f6a30"
  },
  "data": null,
  "docs": "https://docs.polymorfa.com/api/errors#invalid-credential"
}

{
  "error": {
    "type": "permission_error",
    "code": "permission_denied",
    "message": "The credential does not have access to this resource.",
    "param": null,
    "request_id": "5f0c2a8e-3b1d-4c6f-9e2a-7d4b1c8f6a30"
  },
  "data": null,
  "docs": "https://docs.polymorfa.com/api/errors#permission-denied"
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "resource_not_found",
    "message": "The resource is unavailable to this caller.",
    "param": null,
    "request_id": "5f0c2a8e-3b1d-4c6f-9e2a-7d4b1c8f6a30"
  },
  "data": null,
  "docs": "https://docs.polymorfa.com/api/errors#resource-not-found"
}

{
  "error": {
    "type": "api_error",
    "code": "internal_error",
    "message": "An unexpected service failure occurred. Keep the request ID for support.",
    "param": null,
    "request_id": "5f0c2a8e-3b1d-4c6f-9e2a-7d4b1c8f6a30"
  },
  "data": null,
  "docs": "https://docs.polymorfa.com/api/errors#internal-error"
}

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.

Path Parameters

session

string

required

Identifier of the connected Polymorfa session.

Body

application/json

recipientMode

string

required

Behavior selected for recipient.

enabled

boolean

required

Whether this feature is enabled.

allowedActions

string

default:""

Specifies allowed actions for this management platform access set client rules request.

Value constraints

Constraint	Accepted input
String length	At most `1024` characters

Maximum string length: 1024

rateLimit

integer

default:0

Specifies rate limit for this management platform access set client rules request.

Value constraints

Constraint	Accepted input
Numeric value	`0` or greater

Required range: x >= 0

maxDaily

integer

default:0

Specifies max daily for this management platform access set client rules request.

Value constraints

Constraint	Accepted input
Numeric value	`0` or greater

Required range: x >= 0

allowedOrigins

string

default:""

Specifies allowed origins for this management platform access set client rules request.

Value constraints

Constraint	Accepted input
String length	At most `8192` characters

Maximum string length: 8192

maxConcurrency

integer

default:0

Specifies max concurrency for this management platform access set client rules request.

Value constraints

Constraint	Accepted input
Numeric value	`0` or greater

Required range: x >= 0

allowedNumber

string

default:""

Specifies allowed number for this management platform access set client rules request.

Value constraints

Constraint	Accepted input
String length	At most `8192` characters

Maximum string length: 8192

maxSetupsPerMinute

integer

default:0

Specifies max setups per minute for this management platform access set client rules request.

Value constraints

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

Required range: 0 <= x <= 600

conversationTtlSeconds

integer

default:86400

How long, in seconds, a sender remains replyable in conversation mode after their latest inbound message. Must be between 300 (5 minutes) and 604800 (7 days). Defaults to 86400 (24 hours).

Value constraints

Constraint	Accepted input
Numeric value	`300` through `604800` (inclusive)

Required range: 300 <= x <= 604800

Response

Rules saved

success

boolean

required

Whether the request succeeded.

message

string

Human-readable message associated with this result.

Set client rules

curl --request PUT \
  --url https://api.polymorfa.com/platform/sessions/{session}/client-rules \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "recipientMode": "<string>",
  "enabled": true
}
'

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

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

import requests

url = "https://api.polymorfa.com/platform/sessions/{session}/client-rules"

payload = {
    "recipientMode": "<string>",
    "enabled": True
}
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/{session}/client-rules"

	payload := strings.NewReader("{\n  \"recipientMode\": \"<string>\",\n  \"enabled\": true\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))

}

{
  "success": true,
  "message": "<string>"
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "invalid_parameter",
    "message": "Correct the invalid request field.",
    "param": null,
    "request_id": "5f0c2a8e-3b1d-4c6f-9e2a-7d4b1c8f6a30"
  },
  "data": null,
  "docs": "https://docs.polymorfa.com/api/errors#invalid-parameter"
}

{
  "error": {
    "type": "authentication_error",
    "code": "invalid_credential",
    "message": "Supply a valid credential.",
    "param": null,
    "request_id": "5f0c2a8e-3b1d-4c6f-9e2a-7d4b1c8f6a30"
  },
  "data": null,
  "docs": "https://docs.polymorfa.com/api/errors#invalid-credential"
}

{
  "error": {
    "type": "permission_error",
    "code": "permission_denied",
    "message": "The credential does not have access to this resource.",
    "param": null,
    "request_id": "5f0c2a8e-3b1d-4c6f-9e2a-7d4b1c8f6a30"
  },
  "data": null,
  "docs": "https://docs.polymorfa.com/api/errors#permission-denied"
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "resource_not_found",
    "message": "The resource is unavailable to this caller.",
    "param": null,
    "request_id": "5f0c2a8e-3b1d-4c6f-9e2a-7d4b1c8f6a30"
  },
  "data": null,
  "docs": "https://docs.polymorfa.com/api/errors#resource-not-found"
}

{
  "error": {
    "type": "api_error",
    "code": "internal_error",
    "message": "An unexpected service failure occurred. Keep the request ID for support.",
    "param": null,
    "request_id": "5f0c2a8e-3b1d-4c6f-9e2a-7d4b1c8f6a30"
  },
  "data": null,
  "docs": "https://docs.polymorfa.com/api/errors#internal-error"
}

Overview

Messaging API

Platform API

Graph API

Webhook events

Authorizations

Path Parameters

Body

Response