Skip to main content
PATCH
Update a contact

Authorizations

Authorization
string
header
required

An API key from Settings > API keys (lsk_...), which acts on its own business, or a platform key from the PLATFORM_API_KEYS setting (lsp_...), which onboards and manages businesses. Scopes: business:read, business:write, calls:read, contacts:read, contacts:write, appointments:read, appointments:write, messages:read, knowledge:read, knowledge:write, webhooks:manage, billing:manage, phone_numbers:manage, team:manage, businesses:create, users:create, phone_numbers:purchase, partner:read, partner.businesses:write, partner.demos:write, partner.packages:write, partner.branding:write, partner.templates:write, partner.team:write, partner.billing:read, partner.billing:write. Only platform keys can hold businesses:create and users:create, and only a key a partner made in its console can hold the partner scopes, which the Partner endpoints use. Only a partner's owners grant partner.billing:read and partner.billing:write.

Headers

LobbyStack-Business
string<uuid>

The business a platform key acts on. Required with a platform key. A per-business key may leave it out; if it sends one, it must be the key's own business.

Path Parameters

contact_id
string<uuid>
required

The contact id.

Body

application/json
name
string | null
Required string length: 1 - 200
phone
string

Phone number in E.164 format.

Pattern: ^\+[1-9]\d{6,14}$
email
string<email> | null
Maximum string length: 320
locale
enum<string> | null

Language for the contact's reminders and confirmations: en, fr, es or sr.

Available options:
en,
fr,
es,
sr
timezone
string | null
Required string length: 1 - 80

Response

OK

data
object
required