Contacts API: Create a contact
gapify_client_create_contactCreate a contact in a Gapify inbox through the Contacts API to add customer details such as identifier, email, name, phone, avatar, and custom attributes.
Instructions
Create a contact [Contacts API] POST /public/api/v1/inboxes/{inbox_identifier}/contacts Body fields: identifier, identifier_hash, email, name, phone_number, avatar_url, custom_attributes. Extra fields can be passed via extra_body. Text values may be written in Persian (Farsi) or any other language and are sent unchanged; IDs, numbers and phone numbers may use Persian or Arabic-Indic digits.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | No | Name of the contact | |
| No | Email of the contact Example: "user@example.com" | ||
| avatar_url | No | The url to a jpeg, png file for the user avatar Example: "https://example.com" | |
| extra_body | No | Additional JSON body fields to merge into the request (for keys not listed above). | |
| identifier | No | External identifier of the contact | |
| phone_number | No | Phone number of the contact | |
| identifier_hash | No | Identifier hash prepared for HMAC authentication | |
| inbox_identifier | Yes | The identifier obtained from API inbox channel | |
| custom_attributes | No | Custom attributes of the customer Example: {} |