SettingsOperation settings.clientsUpdate

Settings clients update

Change client settings: documents written on booking and after a call, their models, quiet-client days, the morning digest, the kickoff and booking links, the onboarding template.

PATCH/api/v1/settings/clients

Scope admin: Provider keys, developer keys, mailboxes, domains, settings, fixed costs.

Parameters

Body

A JSON object. Fields not listed are ignored.

Name	In	Description
`auto_documents`	body, array	Documents written the moment a call is booked: discovery_brief, sales_script.
`auto_after_call`	body, array	Documents written when the call recording lands: recap, follow_up_email, call_grade, proposal.
`document_models`	body, object	Model per document kind.
`quiet_days`	body, integer	Days without client activity before a quiet-client alert (14).
`digest`	body, boolean	The morning digest in the bell (on unless false).
`digest_email`	body, boolean	Also email the digest to owners and admins.
`kickoff_url`	body	The link clients book the kickoff with.
`booking_url`	body	The booking link nurture emails use; the Cal.com account when left out.
`onboarding`	body, object	Onboarding template: {items, milestones, questions}.
`onboarding_email`	body, object	The onboarding email: {subject, body}, tags {{first_name}} {{last_name}} {{company}} {{portal_link}} {{booking_link}} {{sender_name}}.

Example

curl

curl -X PATCH "https://crm.ashwanth.dev/api/v1/settings/clients" \
  -H "Authorization: Bearer $SALES_ENGINE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "auto_documents": [],
  "auto_after_call": [],
  "document_models": {},
  "quiet_days": 0,
  "digest": false,
  "digest_email": false,
  "kickoff_url": "",
  "booking_url": "",
  "onboarding": {},
  "onboarding_email": {}
}'

CLI

sales-engine settings clients-update

The JSON above lists every documented field with a typed placeholder; send only the ones you mean.

Response

A 200 with the result under data, on creation too. Errors come back as an error object with a stable code; see Errors.

Shape

{
  "data": { ... }
}

Run it below to see the live shape for your workspace.

Try it

Runs against this server, as the workspace behind the key.

API key

Kept in this page while you browse the docs, gone on reload, never stored. Signed in to the app? Leave it blank and the call runs as you.

Body (JSON)

Every documented field is listed above; leave out the ones you do not need.

Request

PATCH /api/v1/settings/clients