Sign in
Contacts

Create a contact

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 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

Changed in 2 of the 9 revisions of this API.3115

  • 8ccfb9a461e23114See the full diff
    • ▲

      request body became required

      request-body-became-required

    • ▲

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

      request-property-list-of-types-narrowed

    • ▲

      added 'propertyNames' constraint to the request property customProperties

      request-property-property-names-added

    • ●

      removed the request property waProfileName

      request-property-removed

    • ○

      added the new optional request property tags

      new-optional-request-property

    • ○

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

      request-property-list-of-types-widened

    • ○

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

      request-property-list-of-types-widened

    • ○

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

      request-property-list-of-types-widened

    • ○

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

      request-property-list-of-types-widened

    • ○

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

      request-property-list-of-types-widened

    • ○

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

      request-property-list-of-types-widened

    • ○

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

      request-property-list-of-types-widened

    • ○

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

      request-property-list-of-types-widened

    • ○

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

      request-property-list-of-types-widened

    • ○

      added the non-success response with the status 400

      response-non-success-status-added

    • ○

      added the non-success response with the status 401

      response-non-success-status-added

    • ○

      the response property id became required for the status 201

      response-property-became-required

    • ○

      the id 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 201

      response-property-pattern-added

  • e21feba47bec1See the full diff
    • ○

      added the new optional request property customProperties

      new-optional-request-property