Represent a specific business on Facebook. Make the API call to the business ID.
Represents a business on Facebook. Includes any specified properties and assets belonging to the business.
Starting September 14, 2021, the following fields will throw an error for version 12.0+ calls made by apps that lack the endpoint's required permissions. This change will apply to all versions on December 13, 2021.
collaborative_ads_managed_partner_business_info
GET /v21.0/{business-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-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-id}",
function (response) {
if (response && !response.error) {
/* handle the result */
}
}
);
/* make the API call */
new GraphRequest(
AccessToken.getCurrentAccessToken(),
"/{business-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-id}"
parameters:params
HTTPMethod:@"GET"];
[request startWithCompletionHandler:^(FBSDKGraphRequestConnection *connection,
id result,
NSError *error) {
// Handle the result
}];
Field | Description |
---|---|
id numeric string | The business account ID. |
block_offline_analytics bool | Specifies whether offline analytics for business is blocked. |
collaborative_ads_managed_partner_business_info ManagedPartnerBusiness | collaborative_ads_managed_partner_business_info |
collaborative_ads_managed_partner_eligibility BusinessManagedPartnerEligibility | collaborative_ads_managed_partner_eligibility |
created_by BusinessUser|SystemUser | The creator of this business. |
created_time datetime | The creation time of this business. |
extended_updated_time datetime | The update time of the extended credits for this business. |
is_hidden bool | If |
link string | URI for business profile page. |
name string | The name of the business. |
payment_account_id numeric string | The ID for the payment account of this business. |
primary_page | The primary Facebook Page for this business. |
profile_picture_uri string | The profile picture URI of the business. |
timezone_id unsigned int32 | This business's timezone. |
two_factor_type enum | The two factor type authentication used for this business. |
updated_by BusinessUser|SystemUser | The person's name who last updated this business. |
updated_time datetime | The time when this business was last updated. |
verification_status enum | Verification status for this business. |
vertical string | The vertical industry that this business associates with, or belongs to. |
vertical_id unsigned int32 | The ID for the vertical industry. |
Edge | Description |
---|---|
Edge<AdStudy> | The studies this business has access to, such as any advertising lift studies or split testing studies. |
Edge<AdNetworkAnalyticsAsyncQueryResult> | Obtain the results of an asynchronous Audience Network query for this publisher entity. |
Edge<AdsReportBuilderMMMReport> | Marketing mix modeling (MMM) reports generated for this business |
Edge<AdsReportBuilderMMMReportScheduler> | Marketing mix modeling (MMM) reports schedulers for this business |
Edge<AdsPixel> | The business has access to these pixels. |
Edge<Business> | Agencies associated with this business. |
Edge<AdPlacement> | Placements used by this Audience Network business. |
Edge<BusinessAssetGroup> | Business asset groups owned by this business. The business can grant permissions to assets in this group. |
Edge<OmegaCustomerTrx> | The extended credit invoices of this business. |
Edge<BusinessUser> | Business users associated with this business. Includes employees and admins at the business. |
Edge<Application> | This business has access to these client apps. |
Edge<OffsiteSignalContainerBusinessObject> | The business has access to these client offsite signal container business objects |
Edge<Page> | This business has access to these client pages. |
Edge<AdsPixel> | This business has access to these client pixels. |
Edge<ProductCatalog> | This business has access to these client product catalogs. |
Edge<WhatsAppBusinessAccount> | WhatsApp business accounts that were shared to this business. |
Edge<Business> | Clients of this business. |
Edge<CPASCollaborationRequest> | All Collaborative Ads. collaboration requests initiated by the business. |
Edge<CPASAdvertiserPartnershipRecommendation> | Collaborative Ads suggested partners for a business. |
Edge<CommerceMerchantSettings> | Commerce Merchant Settings belonging to this business. |
Edge<EventSourceGroup> | The business owns these event source groups. Includes various signals sources such as pixels. |
Edge<ExtendedCredit> | Extended credits for this business. |
Edge<BusinessAssetSharingAgreement> | The audience sharing requests initiated by this business. |
Edge<InstagramUser> | This business has access to these Instagram accounts. |
Edge<OpenBridgeConfiguration> | Get all the openbridge configurations associated to this business |
Edge<Application> | This business owns these apps. |
Edge<Business> | This business aggregates and manages these client businesses. |
Edge<InstagramUser> | This business owns these Instagram accounts. |
Edge<OffsiteSignalContainerBusinessObject> | owned_offsite_signal_container_business_objects |
Edge<Page> | This business owns these pages. |
Edge<AdsPixel> | This business owns these pixels. |
Edge<ProductCatalog> | This business owns these product catalogs. |
Edge<WhatsAppBusinessAccount> | This business owns these WhatsApp Business Accounts. |
Edge<BusinessAdAccountRequest> | This business requested access to these client ad accounts and is pending approval. |
Edge<BusinessApplicationRequest> | This business requested access to these client apps and is pending approval. |
Edge<BusinessPageRequest> | This business requested access to these client pages and is pending approval. |
Edge<BusinessAdAccountRequest> | This business requested ownership of these ad accounts and is pending approval. |
Edge<BusinessPageRequest> | This business requested ownership of these pages and is pending approval. |
Edge<OffsiteSignalContainerBusinessObject> | This business received sharing requests for these offsite signal container business objects and is pending for approval. |
Edge<BusinessRoleRequest> | Admin for this business invited this user to the business. Pending user approval. |
Edge<WhatsAppBusinessPreVerifiedPhoneNumber> | Edge to get list of all pre-created phone numbers for this business |
Edge<BusinessAssetSharingAgreement> | The audience sharing requests received by this business. |
Edge<ResellerGuidance> | Guidance for a China reseller business. |
Edge<WhatsAppBusinessPartnerClientVerificationSubmission> | Business Service Providers can submit their client information for verification on WhatsApp Business Platform. This endpoint returns statuses, submitted info, and rejection reasons for the submissions. |
Edge<SystemUser> | The business's system users. |
Error | Description |
---|---|
104 | Incorrect signature |
100 | Invalid parameter |
190 | Invalid OAuth 2.0 Access Token |
200 | Permissions error |
368 | The action attempted has been deemed abusive or is otherwise disallowed |
1800100 | The catalog ID is missing |
2500 | Error parsing graph query |
1800000 | Your business needs to complete managed partner ads setup in Collaboration Center |
80004 | There have been too many calls to this ad-account. Wait a bit and try again. For more info, please refer to https://developers.facebook.com/docs/graph-api/overview/rate-limiting#ads-management. |
131000 | Something went wrong |
To create other Business Managers, your business needs to obtain BUSINESS_MANAGEMENT
during the app review process. If your app is in development mode, you can surpass this requirement, but to create only two child businesses.
china_business_onboarding_attributions
edge from the following paths: id
: numeric string, link_with_id
: string, Error | Description |
---|---|
200 | Permissions error |
businesses
edge from the following paths: Parameter | Description |
---|---|
child_business_external_id string | child_business_external_id |
email string | The business email of the business admin |
name string | Username Required |
primary_page numeric string | Primary Page ID |
sales_rep_email string | Sales Rep email address |
survey_business_type enum {AGENCY, ADVERTISER, APP_DEVELOPER, PUBLISHER} | Business Type |
survey_num_assets int64 | Number of Assets in the business |
survey_num_people int64 | Number of People that will work on the business |
timezone_id enum {0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, 62, 63, 64, 65, 66, 67, 68, 69, 70, 71, 72, 73, 74, 75, 76, 77, 78, 79, 80, 81, 82, 83, 84, 85, 86, 87, 88, 89, 90, 91, 92, 93, 94, 95, 96, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 112, 113, 114, 115, 116, 117, 118, 119, 120, 121, 122, 123, 124, 125, 126, 127, 128, 129, 130, 131, 132, 133, 134, 135, 136, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 148, 149, 150, 151, 152, 153, 154, 155, 156, 157, 158, 159, 160, 161, 162, 163, 164, 165, 166, 167, 168, 169, 170, 171, 172, 173, 174, 175, 176, 177, 178, 179, 180, 181, 182, 183, 184, 185, 186, 187, 188, 189, 190, 191, 192, 193, 194, 195, 196, 197, 198, 199, 200, 201, 202, 203, 204, 205, 206, 207, 208, 209, 210, 211, 212, 213, 214, 215, 216, 217, 218, 219, 220, 221, 222, 223, 224, 225, 226, 227, 228, 229, 230, 231, 232, 233, 234, 235, 236, 237, 238, 239, 240, 241, 242, 243, 244, 245, 246, 247, 248, 249, 250, 251, 252, 253, 254, 255, 256, 257, 258, 259, 260, 261, 262, 263, 264, 265, 266, 267, 268, 269, 270, 271, 272, 273, 274, 275, 276, 277, 278, 279, 280, 281, 282, 283, 284, 285, 286, 287, 288, 289, 290, 291, 292, 293, 294, 295, 296, 297, 298, 299, 300, 301, 302, 303, 304, 305, 306, 307, 308, 309, 310, 311, 312, 313, 314, 315, 316, 317, 318, 319, 320, 321, 322, 323, 324, 325, 326, 327, 328, 329, 330, 331, 332, 333, 334, 335, 336, 337, 338, 339, 340, 341, 342, 343, 344, 345, 346, 347, 348, 349, 350, 351, 352, 353, 354, 355, 356, 357, 358, 359, 360, 361, 362, 363, 364, 365, 366, 367, 368, 369, 370, 371, 372, 373, 374, 375, 376, 377, 378, 379, 380, 381, 382, 383, 384, 385, 386, 387, 388, 389, 390, 391, 392, 393, 394, 395, 396, 397, 398, 399, 400, 401, 402, 403, 404, 405, 406, 407, 408, 409, 410, 411, 412, 413, 414, 415, 416, 417, 418, 419, 420, 421, 422, 423, 424, 425, 426, 427, 428, 429, 430, 431, 432, 433, 434, 435, 436, 437, 438, 439, 440, 441, 442, 443, 444, 445, 446, 447, 448, 449, 450, 451, 452, 453, 454, 455, 456, 457, 458, 459, 460, 461, 462, 463, 464, 465, 466, 467, 468, 469, 470, 471, 472, 473, 474, 475, 476, 477, 478, 479, 480} | Timezone ID |
vertical enum {NOT_SET, ADVERTISING, AUTOMOTIVE, CONSUMER_PACKAGED_GOODS, ECOMMERCE, EDUCATION, ENERGY_AND_UTILITIES, ENTERTAINMENT_AND_MEDIA, FINANCIAL_SERVICES, GAMING, GOVERNMENT_AND_POLITICS, MARKETING, ORGANIZATIONS_AND_ASSOCIATIONS, PROFESSIONAL_SERVICES, RETAIL, TECHNOLOGY, TELECOM, TRAVEL, NON_PROFIT, RESTAURANT, HEALTH, LUXURY, OTHER} | Vertical ID Required |
id
in the return type.id
: numeric string, name
: string, Error | Description |
---|---|
100 | Invalid parameter |
3912 | There was a technical issue and the changes you made to your Business Manager weren't saved. Please try again. |
3974 | The name you chose for this Business Manager is not valid. Try a different name. |
3918 | The Facebook Page you've tried to add is already owned by another Business Manager. You can still request access to this Page, but your request will need to be approved by the Business Manager that owns it. |
368 | The action attempted has been deemed abusive or is otherwise disallowed |
3947 | You are trying to create a Business Manager with the same name as one you are already a part of. Please pick a different name. |
42000 | This Page can't be added because it's already linked to an Instagram business profile. To add this Page to Business Manager, go to Instagram and convert to a personal account or change the Page linked to your business profile. |
3973 | The name you chose for this Business Manager is not valid. Please choose another. |
3992 | Your payment account is disabled. |
owned_businesses
edge from the following paths: Parameter | Description |
---|---|
name string | name Required |
array<enum {MANAGE, CREATE_CONTENT, MODERATE, MESSAGING, ADVERTISE, ANALYZE, MODERATE_COMMUNITY, MANAGE_JOBS, PAGES_MESSAGING, PAGES_MESSAGING_SUBSCRIPTIONS, READ_PAGE_MAILBOXES, VIEW_MONETIZATION_INSIGHTS, MANAGE_LEADS, PROFILE_PLUS_FULL_CONTROL, PROFILE_PLUS_MANAGE, PROFILE_PLUS_FACEBOOK_ACCESS, PROFILE_PLUS_CREATE_CONTENT, PROFILE_PLUS_MODERATE, PROFILE_PLUS_MODERATE_DELEGATE_COMMUNITY, PROFILE_PLUS_MESSAGING, PROFILE_PLUS_ADVERTISE, PROFILE_PLUS_ANALYZE, PROFILE_PLUS_REVENUE, PROFILE_PLUS_MANAGE_LEADS, CASHIER_ROLE}> | page_permitted_tasks |
sales_rep_email string | sales_rep_email |
shared_page_id numeric string | shared_page_id |
should_generate_name boolean | should_generate_name This parameter allows the automatic creation of a Child Business Manager when set to true, using a cleaned version of the name provided in the required name parameter. If this option is used, the updated name will be returned as part of the API response. |
survey_business_type enum {AGENCY, ADVERTISER, APP_DEVELOPER, PUBLISHER} | survey_business_type |
survey_num_assets int64 | survey_num_assets |
survey_num_people int64 | survey_num_people |
timezone_id enum {0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, 62, 63, 64, 65, 66, 67, 68, 69, 70, 71, 72, 73, 74, 75, 76, 77, 78, 79, 80, 81, 82, 83, 84, 85, 86, 87, 88, 89, 90, 91, 92, 93, 94, 95, 96, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 112, 113, 114, 115, 116, 117, 118, 119, 120, 121, 122, 123, 124, 125, 126, 127, 128, 129, 130, 131, 132, 133, 134, 135, 136, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 148, 149, 150, 151, 152, 153, 154, 155, 156, 157, 158, 159, 160, 161, 162, 163, 164, 165, 166, 167, 168, 169, 170, 171, 172, 173, 174, 175, 176, 177, 178, 179, 180, 181, 182, 183, 184, 185, 186, 187, 188, 189, 190, 191, 192, 193, 194, 195, 196, 197, 198, 199, 200, 201, 202, 203, 204, 205, 206, 207, 208, 209, 210, 211, 212, 213, 214, 215, 216, 217, 218, 219, 220, 221, 222, 223, 224, 225, 226, 227, 228, 229, 230, 231, 232, 233, 234, 235, 236, 237, 238, 239, 240, 241, 242, 243, 244, 245, 246, 247, 248, 249, 250, 251, 252, 253, 254, 255, 256, 257, 258, 259, 260, 261, 262, 263, 264, 265, 266, 267, 268, 269, 270, 271, 272, 273, 274, 275, 276, 277, 278, 279, 280, 281, 282, 283, 284, 285, 286, 287, 288, 289, 290, 291, 292, 293, 294, 295, 296, 297, 298, 299, 300, 301, 302, 303, 304, 305, 306, 307, 308, 309, 310, 311, 312, 313, 314, 315, 316, 317, 318, 319, 320, 321, 322, 323, 324, 325, 326, 327, 328, 329, 330, 331, 332, 333, 334, 335, 336, 337, 338, 339, 340, 341, 342, 343, 344, 345, 346, 347, 348, 349, 350, 351, 352, 353, 354, 355, 356, 357, 358, 359, 360, 361, 362, 363, 364, 365, 366, 367, 368, 369, 370, 371, 372, 373, 374, 375, 376, 377, 378, 379, 380, 381, 382, 383, 384, 385, 386, 387, 388, 389, 390, 391, 392, 393, 394, 395, 396, 397, 398, 399, 400, 401, 402, 403, 404, 405, 406, 407, 408, 409, 410, 411, 412, 413, 414, 415, 416, 417, 418, 419, 420, 421, 422, 423, 424, 425, 426, 427, 428, 429, 430, 431, 432, 433, 434, 435, 436, 437, 438, 439, 440, 441, 442, 443, 444, 445, 446, 447, 448, 449, 450, 451, 452, 453, 454, 455, 456, 457, 458, 459, 460, 461, 462, 463, 464, 465, 466, 467, 468, 469, 470, 471, 472, 473, 474, 475, 476, 477, 478, 479, 480} | timezone_id |
vertical enum {NOT_SET, ADVERTISING, AUTOMOTIVE, CONSUMER_PACKAGED_GOODS, ECOMMERCE, EDUCATION, ENERGY_AND_UTILITIES, ENTERTAINMENT_AND_MEDIA, FINANCIAL_SERVICES, GAMING, GOVERNMENT_AND_POLITICS, MARKETING, ORGANIZATIONS_AND_ASSOCIATIONS, PROFESSIONAL_SERVICES, RETAIL, TECHNOLOGY, TELECOM, TRAVEL, NON_PROFIT, RESTAURANT, HEALTH, LUXURY, OTHER} | vertical Required |
id
in the return type.id
: numeric string, name
: string, Error | Description |
---|---|
100 | Invalid parameter |
3913 | It doesn't look like you have permission to create a new Business Manager. |
200 | Permissions error |
368 | The action attempted has been deemed abusive or is otherwise disallowed |
3974 | The name you chose for this Business Manager is not valid. Try a different name. |
3947 | You are trying to create a Business Manager with the same name as one you are already a part of. Please pick a different name. |
102 | Session key invalid or no longer valid |
3973 | The name you chose for this Business Manager is not valid. Please choose another. |
/{business_id}
.Parameter | Description |
---|---|
entry_point string | entry point of claiming BusinessClaimAssetEntryPoint |
name string | Business's name |
primary_page numeric string or integer | Primary page of this business |
timezone_id int64 | Timezone id of this business |
two_factor_type enum{none, admin_required, all_required} | Two-factor type of the business |
vertical enum {NOT_SET, ADVERTISING, AUTOMOTIVE, CONSUMER_PACKAGED_GOODS, ECOMMERCE, EDUCATION, ENERGY_AND_UTILITIES, ENTERTAINMENT_AND_MEDIA, FINANCIAL_SERVICES, GAMING, GOVERNMENT_AND_POLITICS, MARKETING, ORGANIZATIONS_AND_ASSOCIATIONS, PROFESSIONAL_SERVICES, RETAIL, TECHNOLOGY, TELECOM, TRAVEL, NON_PROFIT, RESTAURANT, HEALTH, LUXURY, OTHER} | Vertical type of the business |
id
in the return type.id
: numeric string, Error | Description |
---|---|
3974 | The name you chose for this Business Manager is not valid. Try a different name. |
3910 | You need permission to edit the details of your Business Manager. Please talk to one of your Business Manager admins about changing your role or editing the Business Manager details. |
3911 | You need permission to set up a new Business Manager. |
100 | Invalid parameter |
3918 | The Facebook Page you've tried to add is already owned by another Business Manager. You can still request access to this Page, but your request will need to be approved by the Business Manager that owns it. |
3947 | You are trying to create a Business Manager with the same name as one you are already a part of. Please pick a different name. |
3912 | There was a technical issue and the changes you made to your Business Manager weren't saved. Please try again. |
3973 | The name you chose for this Business Manager is not valid. Please choose another. |
368 | The action attempted has been deemed abusive or is otherwise disallowed |
190 | Invalid OAuth 2.0 Access Token |
/{business_id}/managed_businesses
.Parameter | Description |
---|---|
child_business_external_id string | child_business_external_id |
existing_client_business_id numeric string | Existing client business id provided by the client |
name string | Client business name that's managed by the aggregator business |
sales_rep_email string | Email of sales representative of the business that's managed by the aggregator business |
survey_business_type enum {AGENCY, ADVERTISER, APP_DEVELOPER, PUBLISHER} | Business type of surveyed business that's managed by the aggregator business |
survey_num_assets int64 | Number of assets surveyed of business that's managed by the aggregator business |
survey_num_people int64 | Number of people surveyed of business that's managed by the aggregator business |
timezone_id enum {0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, 62, 63, 64, 65, 66, 67, 68, 69, 70, 71, 72, 73, 74, 75, 76, 77, 78, 79, 80, 81, 82, 83, 84, 85, 86, 87, 88, 89, 90, 91, 92, 93, 94, 95, 96, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 112, 113, 114, 115, 116, 117, 118, 119, 120, 121, 122, 123, 124, 125, 126, 127, 128, 129, 130, 131, 132, 133, 134, 135, 136, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 148, 149, 150, 151, 152, 153, 154, 155, 156, 157, 158, 159, 160, 161, 162, 163, 164, 165, 166, 167, 168, 169, 170, 171, 172, 173, 174, 175, 176, 177, 178, 179, 180, 181, 182, 183, 184, 185, 186, 187, 188, 189, 190, 191, 192, 193, 194, 195, 196, 197, 198, 199, 200, 201, 202, 203, 204, 205, 206, 207, 208, 209, 210, 211, 212, 213, 214, 215, 216, 217, 218, 219, 220, 221, 222, 223, 224, 225, 226, 227, 228, 229, 230, 231, 232, 233, 234, 235, 236, 237, 238, 239, 240, 241, 242, 243, 244, 245, 246, 247, 248, 249, 250, 251, 252, 253, 254, 255, 256, 257, 258, 259, 260, 261, 262, 263, 264, 265, 266, 267, 268, 269, 270, 271, 272, 273, 274, 275, 276, 277, 278, 279, 280, 281, 282, 283, 284, 285, 286, 287, 288, 289, 290, 291, 292, 293, 294, 295, 296, 297, 298, 299, 300, 301, 302, 303, 304, 305, 306, 307, 308, 309, 310, 311, 312, 313, 314, 315, 316, 317, 318, 319, 320, 321, 322, 323, 324, 325, 326, 327, 328, 329, 330, 331, 332, 333, 334, 335, 336, 337, 338, 339, 340, 341, 342, 343, 344, 345, 346, 347, 348, 349, 350, 351, 352, 353, 354, 355, 356, 357, 358, 359, 360, 361, 362, 363, 364, 365, 366, 367, 368, 369, 370, 371, 372, 373, 374, 375, 376, 377, 378, 379, 380, 381, 382, 383, 384, 385, 386, 387, 388, 389, 390, 391, 392, 393, 394, 395, 396, 397, 398, 399, 400, 401, 402, 403, 404, 405, 406, 407, 408, 409, 410, 411, 412, 413, 414, 415, 416, 417, 418, 419, 420, 421, 422, 423, 424, 425, 426, 427, 428, 429, 430, 431, 432, 433, 434, 435, 436, 437, 438, 439, 440, 441, 442, 443, 444, 445, 446, 447, 448, 449, 450, 451, 452, 453, 454, 455, 456, 457, 458, 459, 460, 461, 462, 463, 464, 465, 466, 467, 468, 469, 470, 471, 472, 473, 474, 475, 476, 477, 478, 479, 480} | Timezone id of business that's managed by the aggregator business |
vertical enum {NOT_SET, ADVERTISING, AUTOMOTIVE, CONSUMER_PACKAGED_GOODS, ECOMMERCE, EDUCATION, ENERGY_AND_UTILITIES, ENTERTAINMENT_AND_MEDIA, FINANCIAL_SERVICES, GAMING, GOVERNMENT_AND_POLITICS, MARKETING, ORGANIZATIONS_AND_ASSOCIATIONS, PROFESSIONAL_SERVICES, RETAIL, TECHNOLOGY, TELECOM, TRAVEL, NON_PROFIT, RESTAURANT, HEALTH, LUXURY, OTHER} | Business vertical of business that's managed by the aggregator business |
id
in the return type.id
: numeric string, name
: string, Error | Description |
---|---|
190 | Invalid OAuth 2.0 Access Token |
42004 | You couldn't create the client business on behalf your client successfully |
200 | Permissions error |
100 | Invalid parameter |
3999 | Creating a Business Manager requires a valid contact email address |
/{business_id}/agencies
.Parameter | Description |
---|---|
business numeric string or integer | The agency's business. Required |
success
: bool, Error | Description |
---|---|
100 | Invalid parameter |
/{business_id}/clients
.Parameter | Description |
---|---|
business numeric string or integer | The client's business. Required |
success
: bool, Error | Description |
---|---|
100 | Invalid parameter |
/{business_id}/pages
.Parameter | Description |
---|---|
page_id Page ID | Page ID. Required |
success
: bool, Error | Description |
---|---|
100 | Invalid parameter |
42001 | This Page can't be removed because it's already linked to an Instagram business profile. To remove this Page from Business Manager, go to Instagram and convert to a personal account or change the Page linked to your business profile. |
3996 | The page does not belong to this Business Manager. |
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. |
200 | Permissions error |
368 | The action attempted has been deemed abusive or is otherwise disallowed |
/{business_id}/instagram_accounts
.Parameter | Description |
---|---|
instagram_account numeric string | Instagram account ID. Required |
success
: bool, Error | Description |
---|---|
100 | Invalid parameter |
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. |
/{business_id}/ad_accounts
.Parameter | Description |
---|---|
adaccount_id string | Ad account ID. Required |
success
: bool, Error | Description |
---|---|
100 | Invalid parameter |
368 | The action attempted has been deemed abusive or is otherwise disallowed |
190 | Invalid OAuth 2.0 Access Token |
/act_{ad_account_id}/agencies
.Parameter | Description |
---|---|
business numeric string | SELF_EXPLANATORY Required |
success
: bool, Error | Description |
---|---|
100 | Invalid parameter |
200 | Permissions error |
/{user_id}/businesses
.Parameter | Description |
---|---|
business numeric string or integer | Business ID |
success
: bool, Error | Description |
---|---|
3914 | It looks like you're trying to remove the last admin from this Business Manager. At least one admin is required in Business Manager. |
100 | Invalid parameter |
368 | The action attempted has been deemed abusive or is otherwise disallowed |
190 | Invalid OAuth 2.0 Access Token |
/{business_id}/owned_businesses
.Parameter | Description |
---|---|
client_id numeric string | client_id Required |
success
: bool, Error | Description |
---|---|
3912 | There was a technical issue and the changes you made to your Business Manager weren't saved. Please try again. |
100 | Invalid parameter |
200 | Permissions error |