API
View as Markdown

Create a contact

POSThttp://localhost:4000/api/contacts/create

Adds someone to your address book.

Your API key needs the contacts.MANAGE permission.

Body Params

firstNamestringrequired

First name.

lastNamestring

Last name.

typestringrequired

Kind of contact. See List contact types.

servicestringrequired

What the contact does, for example PLUMBER. See List contact types.

emailstring

Email address.

countrystringrequired

Country name.

citystring

City.

addressstring

Street address.

websitestring

Website.

phoneCountryCodestringrequired

Two-letter country code of the phone number.

phoneDialCodeintegerrequired

Dial code without the plus sign.

phoneintegerrequired

National phone number, digits only.

notesstring

Notes.

externalLinksarray of values

Links to profiles on other sites.

Responses

200Successful response.
400The request is not valid.
401The API key is missing, invalid, expired or disabled.
403The API key does not have the permission this endpoint needs.