Skip to main content
PATCH
Update client

Authorizations

X-API-Key
string
header
required

Your organization API key. Some operations also need a key that is associated with a user; their pages say so.

Path Parameters

client_id
string
required

ID of the client.

Minimum string length: 1

Body

application/json
name
string

Draft client name.

Minimum string length: 1
web_address
string

Draft client Entendre subdomain slug.

Pattern: ^[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$
contact_name
string | null

Client contact name.

contact_email
string<email> | null

Client contact email.

website
string<uri> | null

Client public website.

is_multi_entity
boolean

Whether the client uses multiple legal entities.

pending_actions
object[]

Client setup actions.

status
enum<string>

New client state. Send it without other fields. A firm API key can only activate a draft; archive and restore need the dashboard.

Available options:
active,
archived

Response

The request succeeded.

data
object
required