Skip to main content
GET
TypeScript

Response

Customer registry status in the response body

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"