Update an address book entry

Scope: write:address-book

Only the fields sent are changed: a field left out is unchanged, and null clears an
optional field. Required fields can't be cleared. address, phoneNumbers and
emailAddresses are replaced whole when sent, as Loop's edit does, and at least one email
address must remain. The agency can't be changed.

user_id is optional: if supplied it must be a Loop agent in the entry's agency, and is
recorded as the agent who changed it; if omitted the agency's first agent is used.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
int64
required

Address book entry ID

Query Params
uuid

Agent id to record as making the change (optional)

Body Params

The fields to change

Changes to an address book entry. Only the fields sent are changed: a field left out is
unchanged, and null clears an optional one. address, phoneNumbers and
emailAddresses are replaced whole when sent, as Loop's edit does.

string | null
string | null
string | null
string | null
string | null
string | null

One of the values from GET /v2/reference/address-book-categories.

string | null
string | null
address
object
phoneNumbers
array of objects | null

Replaces every phone number when sent; null or [] removes them all.

phoneNumbers
emailAddresses
array of objects | null

Replaces every email address when sent. At least one must remain.

emailAddresses
boolean | null
Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
string
enum
Defaults to application/json

Generated from available request content types

Allowed:
Responses

403

The API key doesn't have the scope this endpoint needs.

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
text/plain
application/json
text/json
*/*