Skip to content

Update a contact

PATCH
/v1/contacts/{contact}
curl --request PATCH \
--url https://api.caller9.app/v1/contacts/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "number": "example", "name": "example", "first_name": "example", "last_name": "example", "location": "example", "notes": "example", "mood": "example", "tags": [ "example" ], "favourite": true }'

Updates any provided fields. At least one field is required.

contact
required
string format: uuid

Contact ID (UUID).

Media typeapplication/json
object
number

Phone number. Normalized to E.164 (US assumed when no country code).

string
<= 20 characters
name
string
<= 255 characters
first_name
string
<= 255 characters
last_name
string
<= 255 characters
location
string
<= 255 characters
notes
string
<= 5000 characters
mood

Short mood marker (typically an emoji). An empty string clears it.

string
<= 16 characters
tags
Array<string>
favourite
boolean

Example generated

{
"number": "example",
"name": "example",
"first_name": "example",
"last_name": "example",
"location": "example",
"notes": "example",
"mood": "example",
"tags": [
"example"
],
"favourite": true
}

The updated contact.

Media typeapplication/json
object
contact
required
object
guid
string
organization_guid
string
number

Phone number, E.164 where parseable.

string
first_name
string
last_name
string
location
string
notes
string
mood
string | null
tags

JSON-encoded array of strings, e.g. ["vip","regular"].

string
favourite
integer
Allowed values: 0 1
created_at
string format: date-time
updated_at
string format: date-time
deleted_at

Always null for contacts returned by the API.

string | null

Example

{
"contact": {
"tags": "[\"vip\",\"regular\"]",
"favourite": 0
}
}

The request was invalid.

Media typeapplication/json
object
error
required

Human-readable error message.

string
code

Machine-readable code (authentication failures only, e.g. KEY_EXPIRED, RATE_LIMITED).

string

Example generated

{
"error": "example",
"code": "example"
}

Missing, invalid, expired or revoked API key.

Media typeapplication/json
object
error
required

Human-readable error message.

string
code

Machine-readable code (authentication failures only, e.g. KEY_EXPIRED, RATE_LIMITED).

string

Example generated

{
"error": "example",
"code": "example"
}

Not found, or belongs to another organization.

Media typeapplication/json
object
error
required

Human-readable error message.

string
code

Machine-readable code (authentication failures only, e.g. KEY_EXPIRED, RATE_LIMITED).

string

Example generated

{
"error": "example",
"code": "example"
}

Too many requests for this API key. Retry after Retry-After seconds.

Media typeapplication/json
object
error
required

Human-readable error message.

string
code

Machine-readable code (authentication failures only, e.g. KEY_EXPIRED, RATE_LIMITED).

string

Example generated

{
"error": "example",
"code": "example"
}
Retry-After
integer

Seconds until the rate-limit window resets.