Sign in
latestOpenAPI 3.0.12026-08-192092911.2 MB

916e669fc527

Contacts

Create a contact

Create a new contact (required scope contacts:write)

post/v1/contacts

Headers

Customer-Idinteger required

The customer identifier

Request body

referencestring nullable

The internal reference of the contact - should usually be unique

namestring required

The name of the contact

groupIdinteger required

The unique identifier of the group this contact belongs to

parentIdinteger nullable

The unique identifier of the parent contact of this contact

extraInformationstring nullable

A free text description about the contact

streetstring nullable

The contact street address

townstring nullable

The contact address town / city / village / locality

postalCodestring nullable

The contact address postcode or zipcode

countrystring nullable

The textual name of the contact address country

Example request

{
  "reference": "5514123",
  "name": "Example Company",
  "groupId": 5514123,
  "parentId": 1,
  "extraInformation": "Loyal customer for many years",
  "street": "3150 Century Way",
  "town": "Leeds",
  "postalCode": "LS15 6HU",
  "country": "England",
  "location": {
    "latitude": 51.31349,
    "longitude": -0.7464233
  },
  "customFields": [
    {
      "definitionId": 5514123,
      "value": "High net worth"
    }
  ]
}

Response

Created

idinteger

Identifier of the newly created record