Update project health policy settings

PUT

platform

projects

{projectId}

health-policy

Update project health policy settings

curl --request PUT \
  --url https://api.polymorfa.com/platform/projects/{projectId}/health-policy \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "version": 1,
  "enabled": true,
  "threshold": 50,
  "slowDownMps": 1,
  "emailNotification": true,
  "webhookNotification": true
}
'

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    version: 1,
    enabled: true,
    threshold: 50,
    slowDownMps: 1,
    emailNotification: true,
    webhookNotification: true
  })
};

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

payload = {
    "version": 1,
    "enabled": True,
    "threshold": 50,
    "slowDownMps": 1,
    "emailNotification": True,
    "webhookNotification": 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/projects/{projectId}/health-policy"

	payload := strings.NewReader("{\n  \"version\": 1,\n  \"enabled\": true,\n  \"threshold\": 50,\n  \"slowDownMps\": 1,\n  \"emailNotification\": true,\n  \"webhookNotification\": 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))

}

{
  "data": {
    "projectId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "version": 1,
    "enabled": true,
    "threshold": 50,
    "sessionAction": "none",
    "slowDownMps": 1,
    "emailNotification": true,
    "webhookNotification": true,
    "integrations": {
      "emailConfigured": true,
      "webhookConfigured": true
    }
  }
}

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

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

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

version

integer

required

Specifies version for this management update project health policy input.

Value constraints

Constraint	Accepted input
Numeric value	`0` or greater

Required range: x >= 0

enabled

boolean

required

Whether this feature is enabled.

threshold

integer

required

Specifies threshold for this management update project health policy input.

Value constraints

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

Required range: 0 <= x <= 100

sessionAction

enum<string>

required

Specifies session action for this management update project health policy input.

Allowed values

Value	Meaning
`none`	None.
`stop`	Stop.
`slow_down`	Slow down.
`log_out`	Log out.

Available options:

none,

stop,

slow_down,

log_out

slowDownMps

number | null

required

Specifies slow down mps for this management update project health policy input.

Accepted alternatives

Alternative	Accepted input
Alternative 1	Type: `number`; Numeric value: Greater than `0`
Alternative 2	`null`

Value constraints

Constraint	Accepted input
Numeric value	Greater than `0`

Required range: x > 0

emailNotification

boolean

required

Whether email notification.

webhookNotification

boolean

required

Whether webhook notification.

Response

Success

data

object

required

Structured data carried by this object.

Show child attributes

Update project health policy settings

curl --request PUT \
  --url https://api.polymorfa.com/platform/projects/{projectId}/health-policy \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "version": 1,
  "enabled": true,
  "threshold": 50,
  "slowDownMps": 1,
  "emailNotification": true,
  "webhookNotification": true
}
'

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    version: 1,
    enabled: true,
    threshold: 50,
    slowDownMps: 1,
    emailNotification: true,
    webhookNotification: true
  })
};

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

payload = {
    "version": 1,
    "enabled": True,
    "threshold": 50,
    "slowDownMps": 1,
    "emailNotification": True,
    "webhookNotification": 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/projects/{projectId}/health-policy"

	payload := strings.NewReader("{\n  \"version\": 1,\n  \"enabled\": true,\n  \"threshold\": 50,\n  \"slowDownMps\": 1,\n  \"emailNotification\": true,\n  \"webhookNotification\": 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))

}

{
  "data": {
    "projectId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "version": 1,
    "enabled": true,
    "threshold": 50,
    "sessionAction": "none",
    "slowDownMps": 1,
    "emailNotification": true,
    "webhookNotification": true,
    "integrations": {
      "emailConfigured": true,
      "webhookConfigured": true
    }
  }
}

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

{
  "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 project health policy settings

Authorizations

Path Parameters

Body

Response