Update Messages¶

Update the status of the message.

Prerequisites¶

The OU has obtained the application, or the application is a self-built application in the OU.

Request Format¶

POST https://{apigw-address}/app-portal-service/v2.2/message/update

Request Parameters (Body)¶

Name	Required/Optional	Data Type	Description
messages	Required	MessageUpdateDTO Struct	The list of the messages that needs to be updated. MessageUpdateDTO Struct >>

MessageUpdateDTO Struct¶

Name

Required/Optional

Data Type

Description

messageId

Required

String

The message ID.

accessKey

Required

String

The application’s accessKey for authentication to obtain the data that it is authorized to access. How to get accessKey >>

state

Required

Integer

The updated message status. The following values are supported:

0: Not processed.
1: Processed.

Sample¶

Request Sample¶

url: https://{apigw-address}/app-portal-service/v2.2/message/update

method: POST

requestBody:
{
  "messages": [
    {
      "accessKey": "your_access_key",
      "messageId": "your_message_id",
      "state": 1
    }
  ]
}

Return Sample¶

{
  "code": 0,
  "message": "OK",
  "data": true
}