Private message user
Sends a user a private message. This API can only be called using a user token which can be obtained through:
- Your own Personal API Token
- Generating a token using one of the following
- authorization_code -- This is the authorization step of a 3-legged OAuth 2 flow
- refresh_token -- When a 3-legged OAuth token expires, you can request a new one through this
- password -- This
grant_typeallows you to request a user token by providing a username/password
The message can also be sent as text/plain
The id, email address, or mention name (beginning with an '@') of the user to send a message to.
The message body
Valid length range:
|str | boo||notify||
Whether this message should trigger a user notification (change the tab color, play a sound, notify mobile phones, etc). Each recipient's notification preferences are taken into account.
Determines how the message is treated by our server and rendered inside HipChat applications