Graph API Version

Business Creative Folder

Reading

Represents a Business Creative Folder, it can contain BusinessVideo and BusinessImage.

Example

Graph API Explorer
GET /v5.0/{business-creative-folder-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-creative-folder-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-creative-folder-id}",
    function (response) {
      if (response && !response.error) {
        /* handle the result */
      }
    }
);
/* make the API call */
new GraphRequest(
    AccessToken.getCurrentAccessToken(),
    "/{business-creative-folder-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-creative-folder-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

ID of the Business Creative Folder.

business

Business that owns the Business Creative Folder.

creation_time
datetime

Creation time

description
string

briefly describe the business creative folder

name
string

Business Creative Folder display name

Edges

EdgeDescription

Businesses that have agency permissions on the Business Creative Folder.

Users that have permissions on the creative folder

Validation Rules

ErrorDescription
100Invalid parameter

Creating

You can make a POST request to agencies edge from the following paths:
When posting to this edge, a BusinessCreativeFolder will be created.

Parameters

ParameterDescription
business
business ID

The receiving business that will have access to the Business Creative Folder

Required
permitted_tasks
list<enum {MANAGE_PERMISSIONS, MANAGE_CONTENT, CREATE_CONTENT, VIEW_CONTENT, VIEW_INSIGHTS}>

Tasks assigned to the agency business

Required

Return Type

This endpoint supports read-after-write and will read the node to which you POSTed.
Struct {
success: bool,
share_status: enum,
}

Validation Rules

ErrorDescription
100Invalid parameter
You can make a POST request to assigned_users edge from the following paths:
When posting to this edge, a BusinessCreativeFolder will be created.

Parameters

ParameterDescription
tasks
array<enum {MANAGE_PERMISSIONS, MANAGE_CONTENT, CREATE_CONTENT, VIEW_CONTENT, VIEW_INSIGHTS}>

Business Creative Folder permission tasks to assign this User

Required
user
UID

App-scoped Business User ID

Required

Return Type

This endpoint supports read-after-write and will read the node to which you POSTed.
Struct {
success: bool,
}

Validation Rules

ErrorDescription
200Permissions error
100Invalid parameter

Updating

You can update a BusinessCreativeFolder by making a POST request to /{business_creative_folder_id}.

Parameters

ParameterDescription
description
string

Briefly describe the business creative folder

name
string

Business Creative Folder display name

Required

Return Type

This endpoint supports read-after-write and will read the node to which you POSTed.
Struct {
success: bool,
}

Validation Rules

ErrorDescription
100Invalid parameter

Deleting

You can delete a BusinessCreativeFolder by making a DELETE request to /{business_creative_folder_id}.

Parameters

This endpoint doesn't have any parameters.

Return Type

Struct {
success: bool,
}

Validation Rules

ErrorDescription
200Permissions error
You can dissociate a BusinessCreativeFolder from a BusinessCreativeFolder by making a DELETE request to /{business_creative_folder_id}/agencies.

Parameters

ParameterDescription
business
business ID

business

Required

Return Type

Struct {
success: bool,
}

Validation Rules

ErrorDescription
200Permissions error