Create an address book entry

Scope: write:address-book

The required fields are the ones Loop's own form requires: firstName, lastName,
companyName, category, consentGiven and at least one email address. category must
be on the list from GET /v2/reference/address-book-categories. The postcode is stored in
capitals.

clientId is only needed when the API key reaches more than one agency (client and
network keys); a team key adds to its own agency. teamId may be sent instead, to add to
that office's agency.

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

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
uuid

Agent id to record as the creator (optional)

Body Params

The new entry

A new address book entry. The required fields are the ones Loop's own form requires.

uuid | null

The agency to add it to. Only needed when the API key reaches more than one agency (client
and network keys); a team key uses its own. teamId may be sent instead.

uuid | null

An office of the agency to add it to, instead of clientId.

string | null
string
required
length between 1 and 128
string
required
length between 1 and 128
string | null
string
required
length between 1 and 128
string
required
length ≥ 1

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

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

At least one, as in Loop.

emailAddresses
boolean
required

Whether the contact has agreed to their details being held. The date is recorded as now,
and the agent as the one given by user_id.

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

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
*/*