Add new entity to CrmContacts

POST 
/CrmContacts

Add new entity to CrmContacts

Request

application/json

Body

required

New entity

salutation string
firstName string
lastNamePrefix string
lastName string
companyName string

This property are no longer synced from the contact.

email string
phone1 string
phone2 string
streetName string
houseNumber string
postalCode string
state string
city string
useParentAddress boolean

This property are no longer synced from the contact.

countryIso string

Possible values: <= 2 characters

crmAccountId uuid
contactReference string
id uuid
createdDate date-time
updatedDate date-time
organizationId uuid
reference string
creatorId uuid
customField1 string
customField2 string
customField3 string
customField4 string
customField5 string
organization

Responses

201

Created entity

application/json

Schema

Schema

salutation string
firstName string
lastNamePrefix string
lastName string
companyName string

This property are no longer synced from the contact.

email string
phone1 string
phone2 string
streetName string
houseNumber string
postalCode string
state string
city string
useParentAddress boolean

This property are no longer synced from the contact.

countryIso string

Possible values: <= 2 characters

crmAccountId uuid
contactReference string
id uuid
createdDate date-time
updatedDate date-time
organizationId uuid
reference string
creatorId uuid
customField1 string
customField2 string
customField3 string
customField4 string
customField5 string
organization

Example (from schema)

{
  "salutation": "string",
  "firstName": "string",
  "lastNamePrefix": "string",
  "lastName": "string",
  "companyName": "string",
  "email": "string",
  "phone1": "string",
  "phone2": "string",
  "streetName": "string",
  "houseNumber": "string",
  "postalCode": "string",
  "state": "string",
  "city": "string",
  "useParentAddress": true,
  "countryIso": "string",
  "crmAccountId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "contactReference": "string",
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "createdDate": "2024-12-04T06:46:24.142Z",
  "updatedDate": "2024-12-04T06:46:24.142Z",
  "organizationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "reference": "string",
  "creatorId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "customField1": "string",
  "customField2": "string",
  "customField3": "string",
  "customField4": "string",
  "customField5": "string",
  "organization": {}
}

default

error

application/json

Schema

Schema

error

object

required

code stringrequired

message stringrequired

target string

details

object[]

Array [

code stringrequired

message stringrequired

target string

]

innererror object

The structure of this object is service-specific

Example (from schema)

{
  "error": {
    "code": "string",
    "message": "string",
    "target": "string",
    "details": [
      {
        "code": "string",
        "message": "string",
        "target": "string"
      }
    ],
    "innererror": {}
  }
}

Loading...