Skip to main content
POST
TypeScript

Headers

Idempotency-Key
string

A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours.

Response

Success; response body includes status OPTED_IN

Your customer's organization-wide address registry default. Workspaces without their own setting use this value. GET, POST (opt in), and DELETE (opt out) all return this object.

status
enum<string>
required

NOT_SET, OPTED_IN, or OPTED_OUT. On GET, NOT_SET means no default has been chosen yet. On POST or DELETE, returns OPTED_IN or OPTED_OUT after a successful change.

Available options:
NOT_SET,
OPTED_IN,
OPTED_OUT
Example:

"NOT_SET"