Set session tier override

PATCH

platform

sessions

{sessionId}

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

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

fetch('https://api.polymorfa.com/platform/sessions/{sessionId}', 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}"

payload = {}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(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}"

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

	req, _ := http.NewRequest("PATCH", 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": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "sessionId": "<string>",
    "status": "<string>",
    "tierOverride": "free"
  }
}

{
  "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

tierOverride

enum<string> | null

required

Specifies tier override for this management session tier override request.

Allowed values

Value	Meaning
`free`	Free.
`standard`	Standard.
`pro`	Pro.
`null`	Null.

Accepted alternatives

Alternative	Accepted input
Alternative 1	Type: `string`; Value `free` or `standard` or `pro`
Alternative 2	`null`

Available options:

free,

standard,

pro,

null

projectId

string<uuid>

Identifier of the Polymorfa project that owns this resource.

Value constraints

Constraint	Accepted input
Format	`uuid`

Response

Success

data

object

required

Structured data carried by this object.

Show child attributes

⌘I

Set session tier override

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

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

fetch('https://api.polymorfa.com/platform/sessions/{sessionId}', 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}"

payload = {}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(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}"

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

	req, _ := http.NewRequest("PATCH", 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": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "sessionId": "<string>",
    "status": "<string>",
    "tierOverride": "free"
  }
}

{
  "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

Set session tier override

Authorizations

Path Parameters

Body

Response