Graph API Version

Users or Pages Blocked from a Page

This edge is for managing the set of people or pages blocked from a page. All of these methods require a Page Access Token.

Reading

Returns a list of people who have been blocked from the Page

New Page Experience

This endpoint is supported for New Page Experience.

Example

Graph API Explorer
GET /v21.0/{page-id}/blocked HTTP/1.1
Host: graph.facebook.com
/* PHP SDK v5.0.0 */
/* make the API call */
try {
  // Returns a `Facebook\FacebookResponse` object
  $response = $fb->get(
    '/{page-id}/blocked',
    '{access-token}'
  );
} catch(Facebook\Exceptions\FacebookResponseException $e) {
  echo 'Graph returned an error: ' . $e->getMessage();
  exit;
} catch(Facebook\Exceptions\FacebookSDKException $e) {
  echo 'Facebook SDK returned an error: ' . $e->getMessage();
  exit;
}
$graphNode = $response->getGraphNode();
/* handle the result */
/* make the API call */
FB.api(
    "/{page-id}/blocked",
    function (response) {
      if (response && !response.error) {
        /* handle the result */
      }
    }
);
/* make the API call */
new GraphRequest(
    AccessToken.getCurrentAccessToken(),
    "/{page-id}/blocked",
    null,
    HttpMethod.GET,
    new GraphRequest.Callback() {
        public void onCompleted(GraphResponse response) {
            /* handle the result */
        }
    }
).executeAsync();
/* make the API call */
FBSDKGraphRequest *request = [[FBSDKGraphRequest alloc]
                               initWithGraphPath:@"/{page-id}/blocked"
                                      parameters:params
                                      HTTPMethod:@"GET"];
[request startWithCompletionHandler:^(FBSDKGraphRequestConnection *connection,
                                      id result,
                                      NSError *error) {
    // Handle the result
}];
If you want to learn how to use the Graph API, read our Using Graph API guide.

Parameters

ParameterDescription
uid
int

The ID for the person who has been blocked from the Page

user
int

The person who has been blocked from the Page

Fields

Reading from this edge will return a JSON formatted result:

{ "data": [], "paging": {} }

data

A list of Profile nodes.

paging

For more details about pagination, see the Graph API guide.

Error Codes

ErrorDescription
210User not visible
200Permissions error
100Invalid parameter
283That action requires the extended permission pages_read_engagement and/or pages_read_user_content and/or pages_manage_ads and/or pages_manage_metadata
190Invalid OAuth 2.0 Access Token

Creating

You can make a POST request to blocked edge from the following paths:
When posting to this edge, no Graph object will be created.

Parameters

ParameterDescription
asid
list<numeric string or integer>

List of App Scoped User IDs to block

psid
array<UID>

List of Page Scoped User IDs to block

uid
list<numeric string or integer>

Deprecated. Same as user

user
list<numeric string or integer>

List of User or Page IDs to block. This or uid is required

Return Type

This endpoint supports read-after-write and will read the node to which you POSTed.
Map {
numeric string: bool
}

Error Codes

ErrorDescription
200Permissions error
100Invalid parameter
3802User cannot reblock target so soon after unblocking target
283That action requires the extended permission pages_read_engagement and/or pages_read_user_content and/or pages_manage_ads and/or pages_manage_metadata
368The action attempted has been deemed abusive or is otherwise disallowed
3801User has already blocked the maximum number of people
190Invalid OAuth 2.0 Access Token
210User not visible
104Incorrect signature

Updating

You can't perform this operation on this endpoint.

Deleting

You can dissociate a User from a Page by making a DELETE request to /{page_id}/blocked.

Parameters

ParameterDescription
asid
user/page ID

App Scoped User ID to unblock

psid
UID

Page Scoped User ID to unblock

uid
UID

Deprecated. Same as user

user
UID

List of User or Page IDs to unblock. This or uid is required

Return Type

Struct {
success: bool,
}

Error Codes

ErrorDescription
100Invalid parameter
104Incorrect signature
190Invalid OAuth 2.0 Access Token