API Graph versión

Business Role Request

Lectura

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

Ejemplo

Graph API Explorer
GET /v19.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
}];
Si quieres obtener información sobre cómo usar la API Graph, lee nuestra guía de uso de la API Graph.

Parámetros

Este extremo no tiene ningún parámetro.

Campos

CampoDescripción
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.

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.

Error Codes

ErrorDescripción
104Incorrect signature

Creación

No puedes realizar esta operación en este extremo.

Actualizando

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

Parámetros

ParámetroDescripción
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

ErrorDescripción
100Invalid parameter
415Two 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.
368The action attempted has been deemed abusive or is otherwise disallowed
457The session has an invalid origin
190Invalid OAuth 2.0 Access Token

Eliminando

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

Parámetros

Este extremo no tiene ningún parámetro.

Return Type

Struct {
success: bool,
}

Error Codes

ErrorDescripción
200Permissions error
368The action attempted has been deemed abusive or is otherwise disallowed
415Two 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.
457The session has an invalid origin
100Invalid parameter
190Invalid OAuth 2.0 Access Token