Delete message metadata

Delete metadata entries (key-value pairs) from a specified message by its message UID. Multiple entries can be deleted in a single request.

Request method

POST: https://Base URL/v4/community-channel/message/metadata/delete

Rate limit: 100 requests per second

Signature required: All server API requests require signature verification. See API request signature.

Request body

The request body is in application/json format and supports the following parameters:

Parameter	Type	Required	Description
messageUID	String	Yes	The message UID. Obtainable via the message routing service. See Message routing.
userId	String	Yes	The operator's user ID — the user deleting metadata from the specified message.
channelId	String	Yes	The community channel ID. Required if the message was sent with a subchannel ID; must be omitted if the message was sent without one.
subchannelId	String	No	The subchannel ID.
keys	String[]	Yes	The metadata key(s) to delete. Up to 100 keys per request.

Request example

HTTP

POST /v4/community-channel/message/metadata/delete HTTP/1.1
Host: api.sg-light-api.com
App-Key: uwd1c0sxdlx2
Timestamp: 1585127132438
Nonce: 14314
Signature: 45beb7cc7307889a8e711219a47b7cf6a5b000e8
Content-Type: application/json

{
  "messageUID": "BRGM-DEN2-01E4-BN66",
  "userId": "tjw3zbMrU",
  "channelId": "WNYZbMqpH",
  "keys": ["11111"]
}

Response

The response body contains a JSON object with the following structure:

Field	Type	Description
code	Number	Status code. 0 indicates success.

Response example

HTTP

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{"code":0}