Graph API Version

Business Role Request

Reading

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

Example

Graph API Explorer
GET /v4.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();
// For more complex open graph stories, use `FBSDKShareAPI`
// with `FBSDKShareOpenGraphContent`
/* 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

FieldDescription
id
numeric string

Business role invitation request ID.

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.

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.

invite_link
string

Link where someone can accept or decline the invitation.

owner

Invite someone to join this business.

role
enum

Business role for user invited to the business.

status
enum

Status of the invitation, such as accepted, declined, expired and so on.

updated_by
BusinessUser|SystemUser

User who updated the invitation.

updated_time
datetime

Time invitation updated.

Validation Rules

ErrorDescription
100Invalid 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

ParameterDescription
role
enum {FINANCE_EDITOR, FINANCE_ANALYST, ADS_RIGHTS_REVIEWER, ADMIN, EMPLOYEE}

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,
}

Validation Rules

ErrorDescription
100Invalid parameter

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,
}

Validation Rules

ErrorDescription
200Permissions error
100Invalid parameter