Graph API Version

Business Role Request

Reading

Represents a business user request. See the requests from an admin of the Business for people to join as member of this business.

Example

Graph API Explorer

GET /v21.0/{business-role-request-id} 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(
    '/{business-role-request-id}',
    '{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(
    "/{business-role-request-id}",
    function (response) {
      if (response && !response.error) {
        /* handle the result */
      }
    }
);

/* make the API call */
new GraphRequest(
    AccessToken.getCurrentAccessToken(),
    "/{business-role-request-id}",
    null,
    HttpMethod.GET,
    new GraphRequest.Callback() {
        public void onCompleted(GraphResponse response) {
            /* handle the result */
        }
    }
).executeAsync();

/* make the API call */
FBSDKGraphRequest *request = [[FBSDKGraphRequest alloc]
                               initWithGraphPath:@"/{business-role-request-id}"
                                      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

This endpoint doesn't have any parameters.

Fields

Field	Description
`id` numeric string	Business role invitation request ID. Default
`created_by` BusinessUser\|SystemUser	User who sent the invitation to join this business.
`created_time` datetime	Admin sent this request to someone to join a business at this time.
`email` string	Email of user invited to join the business. Default
`expiration_time` datetime	Invitation to join business expires at this time.
`finance_role` enum	When you invite someone to join business, pre-assign the Finance role.
`invited_user_type` list<enum>	Invited user type of this role request
`owner` Business	Invite someone to join this business.
`role` enum	Business role for user invited to the business. Default
`status` enum	Status of the invitation, such as accepted, declined, expired and so on. Default
`updated_by` BusinessUser\|SystemUser	User who updated the invitation.
`updated_time` datetime	Time invitation updated.

Error Codes

Error	Description
100	Invalid parameter

Creating

You can't perform this operation on this endpoint.

Updating

You can update a BusinessRoleRequest by making a POST request to /{business_role_request_id}.

Parameters

Parameter Description

Parameter	Description
`role` enum {FINANCE_EDITOR, FINANCE_ANALYST, ADS_RIGHTS_REVIEWER, ADMIN, EMPLOYEE, DEVELOPER, PARTNER_CENTER_ADMIN, PARTNER_CENTER_ANALYST, PARTNER_CENTER_OPERATIONS, PARTNER_CENTER_MARKETING, PARTNER_CENTER_EDUCATION, MANAGE, DEFAULT, FINANCE_EDIT, FINANCE_VIEW}	Update invitation to include this role, such as `ADMIN`.

role

enum {FINANCE_EDITOR, FINANCE_ANALYST, ADS_RIGHTS_REVIEWER, ADMIN, EMPLOYEE, DEVELOPER, PARTNER_CENTER_ADMIN, PARTNER_CENTER_ANALYST, PARTNER_CENTER_OPERATIONS, PARTNER_CENTER_MARKETING, PARTNER_CENTER_EDUCATION, MANAGE, DEFAULT, FINANCE_EDIT, FINANCE_VIEW}

Update invitation to include this role, such as ADMIN.

Return Type

This endpoint supports read-after-write and will read the node to which you POSTed.

Struct {

id: numeric string,

}

Error Codes

Error	Description
100	Invalid parameter
415	Two factor authentication required. User have to enter a code from SMS or TOTP code generator to pass 2fac. This could happen when accessing a 2fac-protected asset like a page that is owned by a 2fac-protected business manager.
368	The action attempted has been deemed abusive or is otherwise disallowed
190	Invalid OAuth 2.0 Access Token

Deleting

You can delete a BusinessRoleRequest by making a DELETE request to /{business_role_request_id}.

Parameters

This endpoint doesn't have any parameters.

Return Type

Struct {

success: bool,

}

Error Codes

Error	Description
200	Permissions error
368	The action attempted has been deemed abusive or is otherwise disallowed
415	Two factor authentication required. User have to enter a code from SMS or TOTP code generator to pass 2fac. This could happen when accessing a 2fac-protected asset like a page that is owned by a 2fac-protected business manager.
100	Invalid parameter
190	Invalid OAuth 2.0 Access Token
457	The session has an invalid origin