Contacts

Create a contact

Changed on

Creates a contact in the workspace.

Tags are linked by id or name and must already exist in the workspace — unknown tags are ignored. Use PATCH /contacts/{contactId}/tags to create tags on demand.

customProperties are keyed by property name and only properties already defined in the workspace are persisted.

post/contacts

Request

Request body

firstNamestring nullable
lastNamestring nullable
emailstring nullable
phonestring nullable
occupationstring nullable
genderstring nullable
birthdatestring nullable
agenumber nullable
notesstring nullable
customPropertiesobject

Values for the custom contact properties of the workspace, keyed by property name

Response

Contact created successfully

idstring uuid required

Id of the created contact

Changes

    • breaking

      request body became required

    • breaking

      request property list-of-types was narrowed by removing types integer from media type application/json

    • breaking

      added 'propertyNames' constraint to the request property

    • warning

      removed the request property

    • info

      added the new optional request property

    • info

      request property list-of-types was widened by adding types null to media type application/json

    • info

      request property / list-of-types was widened by adding types number to media type application/json

    • info

      request property list-of-types was widened by adding types null to media type application/json

    • info

      request property list-of-types was widened by adding types null to media type application/json

    • info

      request property list-of-types was widened by adding types null to media type application/json

    • info

      request property list-of-types was widened by adding types null to media type application/json

    • info

      request property list-of-types was widened by adding types null to media type application/json

    • info

      request property list-of-types was widened by adding types null to media type application/json

    • info

      request property list-of-types was widened by adding types null to media type application/json

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      the response property became required for the status

    • info

      the response's property pattern ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$ was added for the status

    • info

      added the new optional request property