Skip to main content
POST
Create or update a contact

Authorizations

Authorization
string
header
required

Send your API key as Authorization: Bearer kai_live_....

Make and revoke keys in Kai, under Settings → API. Kai stores only a hash of the key, so the full key is shown one time.

Body

application/json

A key that you do not send keeps its stored value. A key set to null clears the value.

external_id
string | null
name
string | null
email
string | null
phone
string | null
note
string | null
attributes
object

Values by API name. Kai refuses an unknown or archived key with a 422 response, and names the key that it refused.

owner
string | null

A member id, the email of a member, or null to clear the owner.

identities
object[]

More handles that identify this person.

Response

The contact was found and updated.

data
object