Property contacts

Developing

POST

/properties/{propertyID}/contacts

This end point lets you create new contacts against either customers or work addresses.

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Path Params

Body Params application/jsonRequired

Examples

Responses

🟢201Success

application/json

Headers

Bodyapplication/json

🟠400400 Bad request

🟠401401 Unauthorised

🟠403403 Forbidden

🟠404404 Not found

🟠409409 Conflict

🟠429429 Too many requests

Request Example

Shell

JavaScript

Java

Swift

curl --location '/properties/1146/contacts' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "firstName": "Test 29 June",
    "lastName": "Lakin",
    "position": "Corporate Branding Supervisor",
    "email": "test@gmail.com",
    "telephones": [
        {
            "type": "Office",
            "number": "(261) 925-8829"
        },
        {
            "type": "Mobile",
            "number": "(261) 925-8829 x0414"
        }
    ],
    "communicationPreference": {
        "phone": true,
        "email": true,
        "sms": true
    }
}'

Response Example

201 - Example 1

{
    "id": 0,
    "createdByType": 0,
    "createdByID": 0,
    "createdByUser": "string",
    "createdOnDateTime": "2019-08-24T14:15:22.123Z",
    "lastUpdatedOnDateTime": "2019-08-24T14:15:22.123Z",
    "propertyID": 0,
    "firstName": "string",
    "lastName": "string",
    "position": "string",
    "email": "string",
    "telephones": [
        {
            "id": 0,
            "type": "Office",
            "number": "string"
        }
    ],
    "communicationPreference": {
        "phone": true,
        "email": true,
        "sms": true
    }
}

Modified at 2026-06-29 13:34:38

List property contacts

Property contacts