user

Add Contacts

Add multiple contacts by email addresses.

For each email:

  • If user already exists: Adds them to contacts with status="registered"
  • If user doesn't exist: Sends invitation email and creates contact with status="invited"

Protected endpoint - requires authentication. Returns list of created contact records.

post/api/user/contacts

Request body

emailsstring[] required

Response

Successful Response

external_idstring required
emailstring required
status'invitation_pending' | 'invitation_expired' | 'registered' required
created_atstring required

Changes

Changed in 3 of the 34 revisions of this API.44

  • d14bca97ba8612See the full diff
    • added the new registered enum value to the items/status response property for the response status 200

      response-property-enum-value-added

    • removed the existing_user enum value from the items/status response property for the response status 200

      response-property-enum-value-removed

    • removed the invitation_accepted enum value from the items/status response property for the response status 200

      response-property-enum-value-removed

    This revision also has 5 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • aa4b06f8dede31See the full diff
    • removed the optional property items/last_name from the response with the 200 status

      response-optional-property-removed

    • removed the optional property items/name from the response with the 200 status

      response-optional-property-removed

    • removed the optional property items/user_ext_id from the response with the 200 status

      response-optional-property-removed

    • added the optional property items/user to the response with the 200 status

      response-optional-property-added

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • endpoint added

      endpoint-added