Sign in
Contacts

Create Contact With Permissions

post/api/v1/contacts/with-permissions

Request body

preferred_namestring nullable
name_prefixstring nullable
given_namestring nullable
middle_namestring nullable
family_namestring nullable
name_suffixstring nullable
company_namestring nullable
job_titlestring nullable
birthdaystring date nullable
notesstring nullable
access_identity_idsstring[] nullable

Deprecated. Non-null values are rejected; use contact communication policies instead.

Example request

{
  "phones": [
    {
      "value_e164": "+15551234567"
    }
  ]
}

Response

Successful Response

idstring uuid required
organization_idstring required
preferred_namestring nullable required
name_prefixstring nullable required
given_namestring nullable required
middle_namestring nullable required
family_namestring nullable required
name_suffixstring nullable required
company_namestring nullable required
job_titlestring nullable required
birthdaystring date nullable required
notesstring nullable required
creation_source'manual' | 'vcard' | 'communication' | 'backfill' required
review_status'unreviewed' | 'confirmed' required
reviewed_atstring date-time nullable required
reviewed_bystring nullable required
preferred_name_source'manual' | 'vcard' | 'provider' | 'mail_header' | 'identifier_fallback' required
preferred_name_locked_atstring date-time nullable required
created_by_identity_idstring uuid nullable required
merged_into_contact_idstring uuid nullable required
is_auto_createdboolean required
is_confirmedboolean required
status'active' | 'paused' | 'deleted' required
created_atstring date-time required
updated_atstring date-time required
memory_countinteger required

Changes

Changed in 2 of the 11 revisions of this API.12

  • f3dcdb50fbaa11See the full diff
    • ○

      added the new optional request property //

      new-optional-request-property

    • ○

      added the new optional request property //

      new-optional-request-property

    • ○

      added the new optional request property //

      new-optional-request-property

    • ○

      added the new optional request property //

      new-optional-request-property

    • ○

      added the new optional request property ////

      new-optional-request-property

    • ○

      added the new optional request property ////

      new-optional-request-property

    • ○

      added the new optional request property ////

      new-optional-request-property

    • ○

      added the new optional request property ///

      new-optional-request-property

    • ○

      added the new optional request property ///

      new-optional-request-property

    • ○

      added the new optional request property ///

      new-optional-request-property

    • ○

      added the new optional request property ///

      new-optional-request-property

  • 1393694554cc1See the full diff
    • ○

      endpoint added

      endpoint-added