/persons.json

Creates a new person.

To create, update or delete child objects like fb_person_phone or fb_person_bank_accounts please take a look at the special endpoints like /personPhone, /personBankAccount etc.

Field

Description

Type

Mandatory

company_id

The optional id of a company (= another person) if this contact belongs to a company

integer

company_name

The name of the company if is_company=true

string (1000)

salutation

The salutation (only if is_company=false)

Enum ("Mr.", "Mrs.", "diverse", "couple", "family")

title

The title (only if is_company=false)

string (50)

first_name

The first name (only if is_company=false)

string (100)

last_name

The last name (only if is_company=false)

string (100)

yes

birthday

The birthday (only if is_company=false)

date

position

The position (only if is_company=false)

string (200)

info

Some information about the person

string (1000)

wants_mailing

Information about contact opportunities

boolean

wants_newsletter

Information about contact opportunities

boolean

wants_no_email

Information about contact opportunities

boolean

wants_no_post

Information about contact opportunities

boolean

wants_no_call

Information about contact opportunities

boolean

greeting

A individual greeting

string (1000)

is_company

true of it is a company

boolean

external_person_id

A kind of identifier that is used in any 3rd party systems

string (100)

updated_min

only return persons that are updated since the given date (included the date)

date

updated_max

only return persons that are updated before the given date (included the date)

date

📘

Custom fields

Please find further information about custom fields at the custom fields section.

Language
Authentication
Basic
base64
:
Click Try It! to start a request and see the response here!