Skip to main content
POST

Authorizations

​
Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Body

application/json
​
entity
enum<string>
required

Entity the field belongs to.

Available options:
contact,
company
​
name
string
required

Key to write the field with on POST /contacts or POST /companies. Starts with a lowercase letter, followed by letters and digits only. Identifies the field to update; never changes afterwards.

Maximum string length: 400
Pattern: ^[a-z][a-zA-Z0-9]*$
​
type
enum<string>
required

Field data type. On an existing field, only text or multilineText may differ from the stored type (a conversion), and a phone or user field keeps its type.

Available options:
text,
multilineText,
number,
date,
select,
boolean,
phone,
user,
url
​
label
string

Display name of the field, as shown in lemlist. Cannot contain an HTML tag (<...>). Optional: defaults to name on creation, unchanged when omitted on an update.

Maximum string length: 400
​
upsertOptions
string[]

Select fields only. On creation, the options (at least one). On an update, options to add when missing; the present ones and the others are kept, so the same list replays. Distinct and non-empty; compared as in the app, regardless of case and surrounding spaces (gold matches an existing Gold), and stored without surrounding spaces.

​
renameOptions
object

Select fields only, on an update: { "current value": "new value" }. The option keeps its identity, so the contacts or companies holding the current value are rewritten to the new one.

​
removeOptions
string[]

Select fields only, on an update: options to drop. The contacts or companies holding one are cleared. At least one option must remain.

Response

Field updated (or unchanged, on a replay)

​
success
boolean
​
data
object