Inquirly

Create a conversation

POST

/public/api/v1/inboxes/{inbox_identifier}/contacts/{contact_identifier}/conversations

Conversations API

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST '/public/api/v1/inboxes//contacts//conversations' \
--header 'Content-Type: application/json; charset=utf-8' \
--data-raw '{
    "custom_attributes": {}
}'

Response Example

200 - Example 1

{
    "id": 0,
    "inbox_id": "string",
    "messages": [
        {
            "content": "string",
            "content_type": "text",
            "content_attributes": {},
            "message_type": "incoming",
            "created_at": 0,
            "private": true,
            "attachment": {},
            "sender": {},
            "conversation_id": 0
        }
    ],
    "contact": {}
}

Request

Path Params

inbox_identifier

string

required

contact_identifier

string

required

Body Params application/json; charset=utf-8

custom_attributes

object

optional

Custom attributes of the conversation

Examples

Responses

🟢200OK

application/json; charset=utf-8

Success

Body

integer

optional

Id of the conversation

inbox_id

string

optional

The inbox id of the conversation

messages

array[object (message) {9}]

optional

Messages in the conversation

content

string

optional

The text content of the message

content_type

enum<string>

optional

The type of the template message

Allowed values:

textinput_selectcardsform

content_attributes

object

optional

The content attributes for each content_type

message_type

enum<string>

optional

The type of the message

Allowed values:

incomingoutgoingactivitytemplate

created_at

integer

optional

The time at which message was created

private

boolean

optional

The flags which shows whether the message is private or not

attachment

object

optional

The file object attached to the image

sender

object

optional

User/Agent/AgentBot object

conversation_id

number

optional

ID of the conversation

contact

object

optional

The contact information associated to the conversation

🟠401Unauthorized

Update a contact

List all conversations