Sign in

v1

latestOpenAPI 3.0.12026-08-063985821.3 MB
Contact API:Contacts

Add a new contact

post/contacts

Headers

X-Allow-Duplicatesstring

Duplicate override code from the header of an earlier 409 response

Request body

firstNamestring nullable
lastNamestring nullable
emailstring nullable
phonestring nullable
mobilestring nullable
salutationstring nullable

Salutation/honorific/title

unsubscribedboolean
summarystring nullable
socialobject nullable
positionstring nullable
companyIdinteger nullable
reportsToContactIdinteger nullable
officeAddressIdstring uuid nullable
statusIdinteger nullable

Contact status

ownerUserIdinteger nullable
recruiterUserIdinteger[] nullable
otherEmailstring[] nullable

Example request

{
  "social": {
    "facebook": "https://www.facebook.com/JobAdder",
    "twitter": "https://twitter.com/jobadder",
    "linkedin": "https://www.linkedin.com/company/866656/"
  },
  "custom": [
    {
      "fieldId": 1,
      "value": "Text value"
    },
    {
      "fieldId": 2,
      "value": [
        "List value 1",
        "List value 2"
      ]
    },
    {
      "fieldId": 3,
      "value": "2018-07-01"
    }
  ]
}

Response

Created

contactIdinteger required

Unique identifier for the contact

firstNamestring nullable

First name

lastNamestring nullable

Last name

positionstring nullable

Position or job title

salutationstring nullable

Salutation/honorific/title

unsubscribedboolean
emailstring nullable

Primary email address

phonestring nullable

Phone number

mobilestring nullable

Mobile/cell number

mobileNormalizedstring nullable

Mobile/cell normalized number

inactiveboolean

Contact is no longer with the company

previousContactIdinteger nullable

contactId from the previous company when a contact moves between companies

originalContactIdinteger nullable

contactId from the original/first company when a contact moves between companies

otherEmailstring[] nullable

Other email addresses used by the contact

socialobject nullable

Contact social profiles

summarystring nullable
hiringManagerboolean
createdAtstring date-time nullable
updatedAtstring date-time nullable

Example response

{
  "social": {
    "facebook": "https://www.facebook.com/JobAdder",
    "twitter": "https://twitter.com/jobadder",
    "linkedin": "https://www.linkedin.com/company/866656/"
  },
  "custom": [
    {
      "fieldId": 1,
      "name": "Text Field 1",
      "type": "Text",
      "value": "Text value"
    },
    {
      "fieldId": 2,
      "name": "List Field 2",
      "type": "List",
      "value": [
        "Value 1",
        "Value 2"
      ]
    },
    {
      "fieldId": 3,
      "name": "Date Field 3",
      "type": "Date",
      "value": "2018-07-01"
    }
  ]
}