Skip to content

Business User

Updated: Apr 14, 2025

In Graph API v9.0, access to this endpoint was restricted. In Graph API v10.0, access has been restored to all apps, but apps can now only target businesses (or child businesses of those businesses) that have claimed them.

Reading

Represents a business user. A business user can be an employee of the business or an admin of the business. An Employee can see all of information in business settings and be assigned roles by business admins. An Admin can control all aspects of the business including modifying or deleting the account and adding or removing people from the employee list

Example

Select language

HTTPPHP SDKJavaScript SDKAndroid SDKiOS SDK


GET /v25.0/{business-user-id} HTTP/1.1  
Host: graph.facebook.com

Try it in Graph API Explorer

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 stringThe business user's ID. default
business BusinessBusiness user is associated with this business. default
email stringUser's email as provided in Business Manager.
finance_permission stringFinancial permission role of the user in Business Manager, such as EDITOR, ANALYST, and so on.
first_name stringUser's first name as provided in Business Manager.
ip_permission stringThis user's ads right permission role in Business Manager, such as Reviewer and so on.
last_name stringUser's last name as provided in Business Manager.
name stringName of user as provided in Business Manager. default
pending_email stringEmail for the business user that is still pending verification.
role stringRole of the user in Business Manager, such as Admin, Employee, and so on.
title stringThe title of the user in this business.
two_fac_status stringTwo-factor authentication status of the business-scoped user.

Edges

EdgeDescription
assigned_business_asset_groups Edge<BusinessAssetGroup>Business asset groups that are assign to this business scoped user
assigned_pages Edge<Page>Pages that are assigned to this business scoped user
assigned_product_catalogs Edge<ProductCatalog>Product catalogs that are assigned to this business scoped user
assigned_whatsapp_business_accounts Edge<WhatsAppBusinessAccount>WhatsApp business accounts that are assigned to the business user

Error Codes

Error CodeDescription
100Invalid parameter
104Incorrect signature

Creating

/{business_id}/business_users

You can make a POST request to business_users edge from the following paths:

When posting to this edge, a BusinessUser will be created.

Parameters

ParameterDescription
email stringEmail of user to be added to this business. required
invited_user_type array<enum {FB, MWA}>Not passing a value will default to 'FB'. Use 'MWA' for inviting a user with their Meta account managed by their organization.
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}Role of user to add to this business.

Return Type

This endpoint supports read-after-write and will read the node represented by id in the return type.

Struct  {
id: numeric string,
}

Error Codes

Error CodeDescription
368The action attempted has been deemed abusive or is otherwise disallowed
100Invalid parameter
613Calls to this api have exceeded the rate limit.
457The session has an invalid origin
190Invalid OAuth 2.0 Access Token
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.
200Permissions error
370Invalid call to update this page

Updating

/{business_user_id}

You can update a BusinessUser by making a POST request to /{business_user_id}.

Parameters

ParameterDescription
email stringThe email of the user at this business.
first_name stringFirst name for this business user.
last_name stringLast name for this business user.
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}The role of the user at this business, such as ADMIN and so on.
skip_verification_email booleanWhether to skip sending the verification email. The business persona email still requires verification - but just won't receive an email.

Return Type

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

Struct  {
success: bool,
}

Error Codes

Error CodeDescription
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
190Invalid OAuth 2.0 Access Token
3914It looks like you're trying to remove the last admin from this Business Manager. At least one admin is required in Business Manager.

Deleting

/{business_user_id}

You can delete a BusinessUser by making a DELETE request to /{business_user_id}.

Parameters

This endpoint doesn't have any parameters.

Return Type

Struct  {
success: bool,
}

Error Codes

Error CodeDescription
3914It looks like you're trying to remove the last admin from this Business Manager. At least one admin is required in Business Manager.
100Invalid parameter
200Permissions error
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.

Unofficial mirror for reference/search purposes. All content originates from developers.facebook.com — see the source link at the top of each page. Machine-readable indexes: llms.txt · llms-full.txt · About