Skip to main content
TypeScript

Authorizations

Authorization
string
header
required

Your Periskope API token, sent as Authorization: Bearer <token>. Generate one from the Periskope dashboard under Settings → API & Webhooks. API access requires an active Pro or Enterprise plan.

Path Parameters

property_id
string
required

The property_id (property-xxxxxxxxxxxxxxxx) or the name (case-insensitive) of the custom property. Prefer the property_id — a name that exists as both a chat and a ticket property is ambiguous without the type query parameter.

Minimum string length: 1
Example:

"property-aaaaaaaaaaaa"

Query Parameters

type
enum<string>

Resolves the chat or the ticket property when property_id is a name that exists as both. Not needed when passing a property_id, or when the name only exists under one type.

Available options:
chat,
ticket
Example:

"ticket"

Body

application/json
operation
enum<string>
required

Whether to add the given options to the property ('add') or remove them from it ('remove')

Available options:
add,
remove
Example:

"add"

options
string[]
required

For add: the option labels to add — adding is idempotent, labels that already exist (case-insensitive) are skipped and their existing id returned. For remove: the option ids or labels to remove.

Minimum array length: 1
Example:

Response

Per-entry outcome of the add or remove operation

success
enum<boolean>

Always true when the request was processed

Available options:
true
message
string

Human-readable confirmation message

Example:

"Options updated"

data
object