Custom Channels

Ingest message

This endpoint lets you ingest messages in conversations that use custom channels. When called, it creates a new message in the specified conversation. If the conversation does not exist, the endpoint will automatically create the conversation before adding the message.

You must use an API key with ORG_ADMIN or PROVIDER rights for this endpoint.

⚠️ A 200 OK response does not guarantee that the message was successfully created. It only means the request was received and accepted for processing. ⚠️

post/custom-channels/{channel_id}/messages

Request

Base URL
https://api.partoo.co/v2
Auth
API key in header x-APIKey
TypeScript
https://skmtc.dev/partoo/apis/partoo-rest-api/docs/custom-channels/:channel_id/messages/post.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

channel_idstring required

The id of the custom channel

Request body

business_idstring required

The id of the business.

external_conversation_idstring required

The unique id of the conversation in your system. Messages with the same external_conversation_id & channel_id will be grouped within the same Partoo Conversation.

external_message_idstring required

The unique id of the message in your system. Messages with the same external_message_id & channel_id will be considered as duplicates and will be ignored.

contentstring required

The message content.

sender_type'User' | 'Consumer' required

consumer_namestring nullable

Display name of the consumer. This property is only used at the creation of the conversation.

consumer_imagestring nullable

Profile image URL of the consumer. This property is only used at the creation of the conversation.

Response

status'success'

Changes

No recorded changes to this operation across all 2 revisions of this API.