Chat

Send a chat message

Persists a message and broadcasts it to connected participants. Idempotent via clientMessageId. Messages sent with an API key are signed as the brand unless senderIdentity is "member". A direct thread whose creator has not been invited to viral.app yet is refused with 409 CREATOR_NOT_INVITED: invite them first (POST /creators/{id}/invite).

post/chat/threads/{chatId}/messages

Request

  • Base URL: https://viral.app/api/v1
  • URL: https://viral.app/api/v1/chat/threads/{chatId}/messages
  • Auth: API key in header x-api-key

Path parameters

chatIdstring required

Request body

contentstring required
clientMessageIdstring required
replyToMessageIdstring
attachmentIdsstring[]
senderIdentity'member' | 'org'

API-key calls only: how the creator sees the sender. "org" (the default) sends as the brand alone; "member" puts the key owner's first name in front of the brand ("Dennis from Acme"). Ignored for every other caller, whose messages follow their own chat settings.

Response

OK

Changes

No recorded changes to this operation across all 1 revision of this API.