COconnecteam
Chat:v1:Conversations

Send private message

Send a private message to a specified user within the account. The sender will be a custom publisher. If a conversation between the custom publisher and the addressed user already exists, it will send the message to the same conversation, if not, it will create a new conversation with the specified user.

post/chat/v1/conversations/privateMessage/{userId}

Request

  • Base URL
    https://api.connecteam.com
  • URL
    https://api.connecteam.com/chat/v1/conversations/privateMessage/{userId}
  • Auth
    • API key in header X-API-KEY
    • or OAuth 2
      Client credentials
      Token URL: /oauth/v1/token scopes: chat.write

Path parameters

userIdinteger required

The unique identifier of the user

Request body

senderIdinteger required

The unique identifier of the sender (custom publisher). The custom publishers page can be found in the UI under Settings -> Feed settings.

textstring required

Specifies the text content of the message. Must be in UTF-8 and less than 500 characters.

Response

Successful Response

requestIdstring
dataBaseResponse required

Changes

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