Sign in
latestOpenAPI 3.0.12026-08-192092911.2 MB

916e669fc527

Persons

Create a person

Create a new person (required scope contacts:persons:write)

post/v1/persons

Headers

Customer-Idinteger required

The customer identifier

Request body

contactIdinteger required

The unique identifier of the contact that this person belongs to

titlestring nullable

The person's title

forenamestring required

The person's first name

surnamestring required

The person's second name

emailstring nullable

The email address of the person

mobilestring nullable

The mobile telephone number of the person

landlinestring nullable

The landline telephone number of the person

extensionstring nullable

The landline extension of the person

positionstring nullable

The job role that the person holds within the contact

departmentstring nullable

The department that the person belongs to

isOptedOutboolean

A flag indicating if the contact has opted out of marketing communications

Example request

{
  "contactId": 12345,
  "title": "Mr",
  "forename": "David",
  "surname": "Smith",
  "email": "dave.brown@example.com",
  "mobile": "+447812 123112",
  "landline": "+441312 112441",
  "extension": "12",
  "position": "Manager",
  "department": "Customer service",
  "customFields": [
    {
      "definitionId": 5514123,
      "value": "High net worth"
    }
  ]
}

Response

Created

idstring uuid

Identifier of the newly created record