Inquirly

Create Contact

POST

/api/v1/accounts/{account_id}/contacts

Contacts

Create a new Contact

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST '/api/v1/accounts//contacts' \
--header 'Content-Type: application/json; charset=utf-8' \
--data-raw '{
    "inbox_id": 0,
    "name": "string",
    "email": "string",
    "phone_number": "string",
    "avatar": "string",
    "avatar_url": "string",
    "identifier": "string",
    "custom_attributes": {}
}'

Response Example

200 - Example 1

{
    "payload": {
        "contact": {
            "email": "string",
            "name": "string",
            "phone_number": "string",
            "thumbnail": "string",
            "additional_attributes": {},
            "custom_attributes": {
                "attribute_key": "attribute_value",
                "signed_up_at": "dd/mm/yyyy"
            },
            "contact_inboxes": [
                {
                    "source_id": "string",
                    "inbox": {
                        "id": 0,
                        "name": "string",
                        "website_url": "string",
                        "channel_type": "string",
                        "avatar_url": "string",
                        "widget_color": "string",
                        "website_token": "string",
                        "enable_auto_assignment": true,
                        "web_widget_script": "string",
                        "welcome_title": "string",
                        "welcome_tagline": "string",
                        "greeting_enabled": true,
                        "greeting_message": "string"
                    }
                }
            ]
        }
    },
    "id": 0,
    "availability_status": "online"
}

Request

Path Params

account_id

integer

required

The numeric ID of the account

Body Params application/json; charset=utf-8

inbox_id

number

required

name

string

optional

name of the contact

string

optional

email of the contact

phone_number

string

optional

phone number of the contact

avatar

string <binary>

optional

Send the form data with the avatar image binary or use the avatar_url

avatar_url

string

optional

The url to a jpeg, png file for the contact avatar

identifier

string

optional

A unique identifier for the contact in external system

custom_attributes

object

optional

An object where you can store custom attributes for contact. example {"type":"customer", "age":30}

Examples

Responses

🟢200OK

application/json; charset=utf-8

Success

Body

payload

object

optional

contact

object

optional

number

optional

Id of the user

availability_status

enum<string>

optional

Availability status of the user

Allowed values:

onlineoffline

🟠400Bad Request

List Contacts

Show Contact