Moderate Conversations API for Instagram

We explain how to use the Moderate Conversations API to:

• Block a user
• Unblock a user
• Move a conversation to spam in the Meta Business Suite Inbox

Before You Start

You will need:

• The ID for the Facebook Page linked to your Instagram Professional account
• The Instagram-scoped ID for the customer whom the action will be implemented
• A Page access token requested from a person who can perform the MESSAGE task on the Facebook Page linked to your Instagram Professional account
• instagram_manage_messages, instagram_basic, and business_management permissions. Advanced Access is required to use this API for conversations involving your business and people who do not have a role on your messaging app, your Facebook page, or your business
• A conversation must exist between the user and Instagram business before any of the actions provided by this API can be used

Limitations

• Up to 10 IDs can be provided in each request
• Up to 2 actions can be specified in each request. unblock_user cannot be included in the same request as block_user
• You can not block an instagram user that is linked, through accounts center, to your instagram business account

Request Parameters

user_ids

actions

Block A User

To block messaging with a user, send a POST request to the /PAGE-ID/moderate_conversations endpoint with the instagram-scoped id for the user and the block_user action.

Sample Request

curl -X POST -H "Content-Type: application/json" -d '{
  "user_ids":[
    {
        "id": "{IGSID}"
    }
  ],
  "actions": [
    "block_user"
  ]
}' "https://graph.facebook.com/v22.0/{PAGE-ID}/moderate_conversations?access_token={PAGE-ACCESS-TOKEN}"

On success, your app will receive the following JSON response with the success field set to true. On failure, the success field will be set to false.

"success": "true"

Unblock A User

To unblock a user, send a POST request to the /PAGE-ID/moderate_conversations endpoint with the Instagram-scoped id for the user and the unblock_user action.

Sample Request

curl -X POST -H "Content-Type: application/json" -d '{
  "user_ids":[
    {
        "id":"{IGSID}"
    }
  ],
  "actions": [
    "unblock_user"
  ]
}' "https://graph.facebook.com/v22.0/{PAGE-ID}/moderate_conversations?access_token={PAGE-ACCESS-TOKEN}"

On success, your app will receive the following JSON response with the success field set to true. On failure, the success field will be set to false.

"success": "true"

Move Conversation to Spam

To mark a conversation as spam and move it to the spam folder in the Meta Business Suite inbox, send a POST request to /PAGE-ID/moderate_conversations with the Instagram-scoped id for the user and the move_to_spam action.

Sample Request

curl -X POST -H "Content-Type: application/json" -d '{
  "user_ids":[
    {
        "id":"{IGSID}"
    }
  ],
  "actions": [
    "move_to_spam"
  ]
}' "https://graph.facebook.com/v22.0/{PAGE-ID}/moderate_conversations?access_token={PAGE-ACCESS-TOKEN}"

On success, your app will receive the following JSON response with the success field set to true. On failure, the success field will be set to false.

"success": "true"

Perform Multiple Actions For Multiple Users

If you would like to perform multiple actions at once for a set of users, send a POST request to /PAGE-ID/moderate_conversations with the Instagram-scoped ids for the users and a list of the actions that should be applied to the users.

Sample Request

Block two users and move the conversations to spam.

curl -X POST -H "Content-Type: application/json" -d '{
  "user_ids":[
    {
        "id":"{IGSID}"
    },
    {
        "id":"{IGSID}"
    }
  ],
  "actions": [
    "block_user",
    "move_to_spam"
  ]
}' "https://graph.facebook.com/v22.0/{PAGE-ID}/moderate_conversations?access_token={PAGE-ACCESS-TOKEN}"

On success, your app will receive the following JSON response with the success field set to true. On failure, the success field will be set to false.

"success": "true"

Error Codes

If you are facing any of the following errors while trying to complete the request for multiple users, you can retry the request with one user at a time.