Create a contact - HQ Rental Software

Creates a contact in the category and returns it under the contact key. Send the values as field_<id> keys (see ContactInput). To find the field IDs, call GET /fields?item_type=contacts and GET /fields?item_type=contacts.{category_id}.

The API does not check for duplicates: every call creates a new contact. To keep a link to your own system, send external_contact_type and external_contact_id.

Side effects: the contact is added to the category. When the account has Mailchimp connected and the category syncs to Mailchimp lists, the contact is queued for sync to those lists.

The returned contact has the properties that were saved; created_at and updated_at are in UTC.

Request

Authorization

Path Params

Header Params

Body Params application/jsonRequired

Example

{
    "field_2": "Jane",
    "field_3": "Doe",
    "field_9": {
        "items": [
            {
                "email": "jane.doe@example.com",
                "type": "work"
            }
        ]
    },
    "field_8": {
        "items": [
            {
                "number": "3055550100",
                "cc": "1",
                "type": "mobile"
            }
        ]
    },
    "external_contact_type": "crm",
    "external_contact_id": "A-1029"
}

Responses

🟢200OK

application/json

The created contact. A successful body has no success field. HTTP 200 is also used for failures: such a body has success: false and is an ErrorUnauthorized (status_code 401 or 403).

Bodyapplication/json

Example

{
    "contact": {
        "id": 1533,
        "uuid": "d5a2b3c4-6e7f-4a81-9b02-c3d4e5f60718",
        "label": "Jane Doe",
        "entity": "person",
        "first_name": "Jane",
        "last_name": "Doe",
        "email": "jane.doe@example.com",
        "phone_number": 3055550100,
        "street": "",
        "street2": "",
        "city": "",
        "state": "",
        "zip": "",
        "country": null,
        "external_contact_type": "crm",
        "external_contact_id": "A-1029",
        "verified": true,
        "language": "en",
        "f252": [],
        "created_by": 2,
        "updated_by": 2,
        "created_at": "2026-10-09T03:18:08.000000Z",
        "updated_at": "2026-10-09T03:18:08.000000Z",
        "deleted_at": null
    }
}

🟠422Record Not Found

🟠404Parameter Error