Update an existing priority

patch

https://priorityprotect-api.datadome.co/v1/priorities/{id}

Performs a partial update on the specified priority using JSON Merge Patch semantics (RFC 7396). Only fields provided in the payload are modified; omitted fields remain unchanged.

Immutable fields like id, testingToken, createdAt, and updatedAt are ignored if included. startAt and endAt can be updated independently. For nested objects like preAdmission, the entire object is replaced, not merged.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

uuid

required

Unique identifier of the priority.

Body Params

Partial update of an existing priority. Only the fields provided in the request body are updated; all other fields remain unchanged. Uses JSON Merge Patch semantics (RFC 7396).

Immutable fields (id, testingToken, createdAt, updatedAt) are ignored if present. startAt and endAt can be updated independently. For nested objects like preAdmission, the entire object is replaced, not merged.

name

string

length ≤ 120

Descriptive name of the priority, used for identification in the dashboard and API. Not shown to end users.

maximumConcurrentVisitors

integer

≥ 0

Maximum number of concurrent visitors allowed on your website before new visitors are placed in the waiting room.

inactivityTimeoutMinutes

integer

10 to 30

Defaults to 15

How long a visitor can be inactive before their session expires. Every interaction matching the waiting room scope will automatically reset this countdown. Must be between 10 and 30 minutes.

admissionRatePerMinute

integer

≥ 0

Maximum number of visitors allowed to leave the waiting room and access the website each minute. This smooths traffic bursts and prevents thundering herd effects when the queue opens.

priority

integer

≥ 0

Determines order of evaluation when multiple priorities could apply. Lower values take precedence.

matchingCondition

string

Boolean expression defining which traffic is sent to this priority. Uses DataDome Lucene syntax with AND, OR, NOT operators and field:value matching.

Examples:

domain:www.example.com AND url:/product/*
domain:*
(countrycode:US OR countrycode:CA) AND url:/sale
domain:shop.example.com AND NOT method:GET

preAdmission

object

Pre-admission configuration. If durationMinutes is greater than 0, the pre-admission is active and opens that many minutes before startAt. If durationMinutes is 0, no pre-admission is used.

startAt

date-time | null

UTC timestamp when the priority becomes active (inclusive). ISO 8601 format.

endAt

date-time | null

UTC timestamp when the priority expires and stops accepting visitors (exclusive). ISO 8601 format.

enforceClientSideValidation

boolean

Defaults to true

When true, visitors passing through the queue must successfully execute client-side validation logic in their browser before being granted access to the protected website.

allowAIAgent

boolean

Defaults to false

When true, known AI or automated agents are allowed to bypass the waiting room.

directAccessTrafficType

array of strings

Traffic categories allowed to skip the waiting room entirely. Subset of verifiedBots, customRules. An empty array means no category bypasses.

POST: optional; [], ["verifiedBots"], ["customRules"] or ["verifiedBots","customRules"] are accepted. Omitted defaults to []. Explicit null or unknown values return 400.

PATCH: omit the field to leave the current set untouched. Provide [] to clear it or a subset to replace it. null returns 400.

directAccessTrafficType

Allowed:

isEnabled

boolean

Defaults to true

When true, the priority is active and is triggered if configuration conditions are met. When false, the priority is never triggered.

templateId

uuid | null

Optional template ID (UUID) to associate a waiting room HTML template. Omit or set to null to use no template.

Responses

200Successfully updated priority.

400Bad request - malformed JSON or invalid field types.

401Unauthorized - missing or invalid API key.

403Forbidden. The provided API key is valid, but the user does not have sufficient permissions to perform this operation.

404Resource not found.