Contacts: Create Contact
gapify_create_contactCreate a new contact in a support account by providing an inbox ID and optional details like name, email, phone, avatar, identifier, or custom attributes.
Instructions
Create a new contact in the account [Contacts]
POST /api/v1/accounts/{account_id}/contacts
Auth: User API key (header api-access-token).
Body fields: inbox_id (required), name, email, phone_number, avatar, avatar_url, identifier, 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 | No | Send the form data with the avatar image binary or use the avatar_url | |
| inbox_id | Yes | Numeric ID of the inbox. Example: 0 | |
| account_id | Yes | The numeric ID of the account | |
| avatar_url | No | The url to a jpeg, png file for the contact avatar Example: "https://example.com" | |
| extra_body | No | Additional JSON body fields to merge into the request (for keys not listed above). | |
| identifier | No | A unique identifier for the contact in external system | |
| phone_number | No | phone number of the contact | |
| custom_attributes | No | An object where you can store custom attributes for contact. example {"type":"customer", "age":30} Example: {} |