Send chat message to team

post

https://{example.beyondtrustcloud.com}/api/command/v2/chat-message/team/{id}

Send a chat message to a logged-in member or all members of a team. The chat message can be sent on behalf of an existing member of the team, or it can be sent as a system message.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

required

1 to 2147483647

This is the unique id or code name of the support team to which the chat message will be sent.

Body Params

body

string

required

length ≤ 2048

The chat message body, which can be formatted with a subset of BBCode:

[b]bolded text[/b]
[color=blue]blue text[/color]OR[color=#0000FF]blue text[/color]
[i]italicized text[/i]
[u]underlined text[/u]
[ul][li]list element 1[/li][li]list element 2[/li][/ul]
[url]https://www.beyondtrust.com[/url]

to_rep

int32

1 to 2147483647

The user ID integer that uniquely identifies the Representative team member you want to receive the message. The team chat message will display as a private message sent from the representative specified in impersonate. If this parameter is provided, the impersonate parameter must be provided. If this parameter is not provided, the message will be sent to the entire team.

impersonate

int32

1 to 2147483647

The user ID integer that uniquely identifies the Representative team member you want to appear as the message sender. If this parameter is not provided, the chat message is rendered as a system chat message.

time

date-time

The date-time at which the chat message was originally sent. It must be in the past according to the appliance's clock. If not specified, chat messages are sent with the current time.

Responses

200OK

422One or more request parameters are invalid. The body contains a general error message as well as a validation error dictionary.