Updates specific information on a message.
The following table lists the parameters that this action supports.
Required
Parameter name | Type | Description |
---|---|---|
channel_type | string | Specifies the type of the channel. Acceptable values are open_channels and group_channels. |
channel_url | string | Specifies the URL of the target channel. |
message_id | long | Specifies the unique ID of the message to update. |
The following tables list the properties of an HTTP request that this action supports for updating a text message, file message, and admin message.
Required | Type | Description |
---|---|---|
message_type | string | Specifies the type of the message. The value of MESG represents a text message. |
Optional | Type | Description |
---|---|---|
message | string | Specifies the content of the message. |
custom_type | string | Specifies a custom message type used for message grouping. The length is limited to 128 characters. |
data | string | Specifies additional message information such as custom font size, font type, or |
mention_type | string | Specifies the mentioning method that indicates which user gets a notification of the message. Acceptable values are users and channels. If set to users, only the specified users with the |
mentioned_user_ids[] | array of strings | Specifies an array of one or more IDs of the users who get a notification of the message. |
Properties
Required | Type | Description |
---|---|---|
message_type | string | Specifies the type of the message. The value of FILE represents a file message. |
Optional | Type | Description |
---|---|---|
custom_type | string | Specifies a custom message type used for message grouping. The length is limited to 128 characters. |
data | string | Specifies additional message information regarding the file in |
mention_type | string | Specifies the mentioning method that indicates which user gets a notification of the message. Acceptable values are users and channels. If set to users, only the specified users with the |
mentioned_user_ids[] | array of strings | Specifies an array of one or more IDs of the users who get a notification of the message. |
Properties
Required | Type | Description |
---|---|---|
message_type | string | Specifies the type of the message. The value of ADMM represents an admin message. |
Optional | Type | Description |
---|---|---|
message | string | Specifies the content of the message. |
custom_type | string | Specifies a custom message type used for message grouping. The length is limited to 128 characters. |
data | string | Specifies additional message information such as custom font size, font type, or |
mention_type | string | Specifies the mentioning method that indicates which user gets a notification of the message. Acceptable values are users and channels. If set to users, only the specified users with the |
mentioned_user_ids[] | array of strings | Specifies an array of one or more IDs of the users who get a notification of the message. |
If successful, this action returns an updated message resource in the response body.
In the case of an error, an error object is returned. A detailed list of error codes is available here.