Skip to content

Update Agency Client

PATCH
/agency/clients/{org_id}

Rename a client, or suspend / reactivate it (status).

A suspended client can no longer be targeted with X-Target-Org-Id (403) until reactivated; it stays readable here so it can be reactivated.

Authorizations

Parameters

Path Parameters

org_id
required

Client org id (org_xxx) from GET /agency/clients.

string

Client org id (org_xxx) from GET /agency/clients.

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

object
name
Any of:
string
>= 1 characters <= 120 characters
status
Any of:
string
Allowed values: active suspended

Responses

200

Successful Response

object
data
required
object
created
Any of:
boolean
external_ref
Any of:
string
name
required
string
org_id
required

Client org id (org_xxx). Send it as X-Target-Org-Id.

string
owner_invite
Any of:
string
Allowed values: invited existing_account failed
provisioning
required

pending until the org’s workspace has been set up; targeting it answers 503 until then.

string
Allowed values: ready pending
status
required
string
Allowed values: active suspended
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
notes
Any of:
Array<string>
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer
total_available
Any of:
integer
total_is_lower_bound
Any of:
boolean

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string