Create Chat Message

post

https://{hostname}/api/talk/chat/v1/messages

This operation creates a chat message.

Message Content

A message must contain either text or one attachment, but not both.
Only one attachment is allowed per message.

Authorization and Permissions

An OpenAm or UKG Authentication token is required to send a chat message.
The user must have content creation permission, which can be granted by a Talk administrator.

Body Params

The Create Chat Message request payload. Note: A message must contain either text or one attachment, but not both.

text

string

required

length ≤ 5000

The text of the chat message in plaintext format. Either text or attachment can be provided, but not both. Maximum length is 5000 characters.

recipients

object

required

The recipients of the chat message.

replyTo

string

The ID of the chat message being replied to.

attachment

object

The attachment model used across different content types.

Headers

x-correlation-id

string

A UUID value to track the request, used for debugging and tracing.

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

Language

Credentials

Bearer

JWT

URL

Loading…

Response

Choose an example:

application/json

application/problem+json

201Successfully submitted a chat create request.

400The HTTP status code 400 Bad Request error, thrown when required parameters are not passed.

401The HTTP status code 401 Unauthorized error, thrown when the user is not authorized to access the resource.

403The HTTP status code 403 Forbidden error, thrown when the user is not authorized to access the resource.

405The HTTP status code 405 Method Not Allowed error, thrown when you attempt to call a URI with an unsupported HTTP method.

406The HTTP status code 406 Not Acceptable Content error, thrown when you send a request with accept header other than application/json.

413The HTTP status code 413 Payload Too Large error, thrown when you attempt to pass a request payload that exceeds the limit.

429The HTTP status code 429 Too Many Requests error, thrown when the user exceeds the allowed rate limit for the API.

500The HTTP status code 500 Internal Server error, thrown when the server is not able to process the request.