Skip to main content
PATCH
Reconfigure a service account

Authorizations

x-api-key
string
header
required

Org-issued integration API key (service account credential). The plaintext secret is shown once at creation.

Headers

X-Idempotency-Key
string
required

Stable caller-chosen key (max 200 chars) making the mutation safely retryable.

Maximum string length: 200

Path Parameters

keyId
string
required

Service account (API key) id

Body

application/json
name
string
Required string length: 1 - 100
scopes
enum<string>[]
Minimum array length: 1
Available options:
cases:read,
cases:write,
leads:read,
leads:write,
clients:read,
clients:write,
contacts:read,
contacts:write,
documents:read,
documents:write,
notes:read,
notes:write,
tasks:read,
tasks:write,
calendar:read,
calendar:write,
deadlines:read,
deadlines:write,
intake:read,
intake:write,
esign:read,
esign:write,
billing:read,
billing:write,
funds:read,
funds:write,
referrals:read,
referrals:write,
communications:read,
communications:write,
org:read,
org:manage,
reports:read,
events:read,
webhooks:manage,
medical:read,
medical:write,
pii:read
actingAttorneyId
string | null
Required string length: 1 - 200
reportIncludeChildOrganizations
boolean
webhookAllowedHosts
string[]
Maximum array length: 20
Required string length: 1 - 253
expiresAt
string

Response

{ success: true, serviceAccount }

success
boolean
required
{key}
any