The following macros are not currently supported in the header:
  • style

POST /contacts

The following endpoint should be used to create a brand new contact and affiliation. If you have an existing contact and wish to link it to another company, please see create affiliation.

Resource URL

Create a new contact object.

POST /contacts

Parameters

Table of allowed parameters. Underlined parameters are required.

company_idunsigned intMust point to a valid company. This is the company new affiliated contact will point.
firstnameString 
middlenamestring 
surnamestring 
preferred_namestring 
usernamestringMust be unique. Otherwise you will get invalid_request
passwordstring 
titlestring 
salutationstring 
commentsstring 
statusunsigned intThis must point to a valid affiliation status id, otherwise you will get an invalid_request
standingstringMust be potential, interested, active or inactive, otherwise you will get an invalid_request.
country_idunsigned intMust point to a valid country
physical_address_idunsigned intPhysical address. Must point to a valid address
postal_address_idunsigned intPostal address. Must point to a valid address.
phonestringThe contact's phone number in relation to the affiliated company. e.,g this may be their work number.
faxstringThe contact's fax in relation to the affiliation company. e.g, this may be their work fax number.
emailstringMust be a valid email address
positionstringe.g, CEO, software engineer or volunteer fire fighter.
status_idunsigned intThe affiliations status id. Must point to a valid affiliation status
standingstringe.g, active, inactive
communicationstringMust be yes or no.
invoice_methodstringe.g, email, fax or postal

Handling the response

Returns the created contact object. Please see get contact for details regarding handling of the response.