Graph API Version

CPASCollaboration Request

Reading

A collaboration request is a partnership request coming from a brand or agency to a retailer or marketing partner. Used for Collaborative Ads.

Example

Graph API Explorer
GET /v10.0/{cpas-collaboration-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(
    '/{cpas-collaboration-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(
    "/{cpas-collaboration-request-id}",
    function (response) {
      if (response && !response.error) {
        /* handle the result */
      }
    }
);
/* make the API call */
new GraphRequest(
    AccessToken.getCurrentAccessToken(),
    "/{cpas-collaboration-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:@"/{cpas-collaboration-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

ID for the collaboration request object.

brands
list<string>

List of brands that the advertiser wants to work with the retailer on.

contact_email
string

E-mail provided by the sender business in the reach out form.

contact_first_name
string

First name provided by the sender business in the reach out form.

contact_last_name
string

Last name provided by the sender business in the reach out form.

phone_number
string

Phone number provided by the sender business.

receiver_business

Business that is receiving the collaboration request.

requester_agency_or_brand
enum

Whether the person reaching out is representing a brand or agency.

sender_client_business

Used if the sender business is representing other businesses through the request. This field includes the business or businesses represented.

status
enum

The status of the request handled by the receiver.

Error Codes

ErrorDescription
100Invalid parameter

Creating

You can't perform this operation on this endpoint.

Updating

You can't perform this operation on this endpoint.

Deleting

You can't perform this operation on this endpoint.