Messages

Reject message

Reject a message.

post/v1/messages/{messageId}/reject

Request

  • Base URL
    https://platform.hootsuite.com
  • URL
    https://platform.hootsuite.com/v1/messages/{messageId}/reject
  • Auth
    OAuth 2
    Authorization code: https://platform.hootsuite.com/oauth2/auth
    Token URL: https://platform.hootsuite.com/oauth2/token

Path parameters

messageIdstring required

The message ID.

Headers

Authorizationstring required

A bearer token string used for authentication

Request body

reasonstring required

The rejection reason to be displayed to the creator of the message.

sequenceNumberinteger required

The sequence number of the message being rejected.

reviewerType'EXTERNAL' | 'MEMBER'

The actor that will be rejecting the message. Leaving this field empty will use "EXTERNAL" by default.

Using "MEMBER" requires that you use a member token to reject a message that is pending approval by that member.

Example request

{
  "reason": "Message contains profanity",
  "sequenceNumber": 11
}

Response

Success

dataobject

The data response envelope.

Changes

No recorded changes to this operation across all 1 revision of this API.