Create a contact

Creates a new contact object.

Create a contact

POST https://api.treevox.com/v1/contacts

Creates a new contact object.

Headers

Name	Type	Description
Content-Type*	application/json
Accept-Encoding	gzip
x-api-key*	String	your api key in treevox

Request Body

Name	Type	Description
name*	String	Contact Name
surname	String	Contact's surname
dni	String	Contact identifier
email*	String	Contact email
secondaryEmail	String	Contact secondary email
phone	String	Contact phone number
address	String	Contact address
city	String	Contact city
classification	Number	Contact clasification, value between 1 and 5
userCreatorId	Number	User ID that created this contact. User ID has to be the identifier in treevox. If the User ID does not exist, an error will be returned.
countryCode	String	2-letter country code. The code is based on ISO_3166-1.
stageId	Number	Contact stage. value between 1 and 4. View ContactStage
organizationId	Number	Organization ID of the contact. The organization ID must be the identifier in treevox. If the organization ID does not exist, an error will be returned.
assignedToId	Number	User ID to which this contact will be assigned. If you want to leave it unassigned, do not send this parameter. The User ID must be the identifier in treevox. If the User ID does not exist, an error will be returned.
assignedToEmail	String	Email of the user to whom this contact will be assigned. If you want to leave it unassigned, do not send this parameter. The user's email must be the same as the one they have in treevox. If the user's email does not exist, an error will be returned. assignedToId has higher priority than assignedToEmail.
mobilePhone	String	Contact mobile phone number
urlAvatar	String	Contact url avatar
withSales	Boolean	if the contact has sales. Default is false
jobTitle	String	Contact job title

200: OK Returns a contact object if the call succeeded.

{
  "id": "1",
  "name": "Zelma",
  "surname": "Pacocha",
  "dni": "885838866",
  "jobTitle": "Investor Infrastructure Officer",
  "email": "[e-mail]",
  "secondaryEmail": "[e-mail]",
  "phone": "218-224-9677",
  "mobilePhone": "1-597-960-1880",
  "urlAvatar": "http://placeimg.com/640/480",
  "address": "Sharon Via",
  "withSales": false,
  "city": "East Sylvester",
  "countryId": 31,
  "classification": 74,
  "stageId": 17,
  "organizationId": 65,
  "assignedToId": 59,
  "userCreatorId": 33,
  "createdAt": "2021-06-16T14:20:59.553Z",
  "updatedAt": "2021-11-26T04:39:51.894Z"
}

400: Bad Request Returns error.

{
    "timestamp": "2021-11-25T03:45:20.986Z",
    "message": "Validation failed",
    "code": "bad_request",
    "errors": [
        {
            "property": "field",
            "validator": {
                "isDateString": "value not valid"
            }
        }
    ]
}