/domains/{id}/rate-limit (PUT)

PUT

/domains/{id}/rate-limit

curl --request PUT \
  --url https://example.com/api/v1/domains/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/rate-limit \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "messagesPerHour": 1 }'

Authorizations

• bearer

Parameters

Path Parameters

id

required

string format: uuid

/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/

Request Body^required

Media typeapplication/json

object

messagesPerHour

required

Any of:

integer

integer

<= 1000000

null

null

Example^generated

{
  "messagesPerHour": 1
}

Responses

200

Default Response

Media typeapplication/json

object

override

required

Any of:

integer

integer

<= 9007199254740991

null

null

effective

required

integer

<= 9007199254740991

serverDefault

required

integer

<= 9007199254740991

overrides

required

string

Allowed values: perUserMessagesPerHour perDomainMessagesPerHour

Example

{
  "overrides": "perUserMessagesPerHour"
}