Graph API Version

Messenger Ads Partial Automated Step

Reading

Each step of a CTMLG lead gen message template

Example

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

The id of the object

allow_to_skip
bool

This boolean determines whether a user is given the option to skip a question

answer_crm_field_ids
list<string>

List of crm field ids for answers. These map to answers field

answer_validation_enabled
bool

This boolean determines whether Answer Validation should be enabled

answers
list<string>

List of potential answers user can give

carousel_answers
list<MessengerAdsPartialAutomatedStepCarouselAnswerType>

List of potential answers user can give if carousel options is selected

crm_field_id
string

FieldID which will be used to submit answer to CRM

cta
MessengerAdsPartialAutomatedStepMessengerAdsPartialAutomatedCtaShape

All data necessary to add CTA to step

invalid_reply_text
string

Message text sent to the user when they reply with an invalid answer.

media_content
string

Hash or id of the media content of the broadcast message

media_type
enum

Media type of the broadcast message

message
string

Message sent to user in this step

next_step_ids
list<numeric string>

List of next steps. These map to answers above

options_format
enum

Format option for multiple choice options

prefill_type
enum

Type of prefill expected: email, zip code etc

qualifying_answers_list
list<string>

List of advertiser-designated valid answers that are used to determine whether or not a lead should be disqualified. Currently being used for ZIP code disqualification.

reply_type
enum

Type of Reply expected: Quick Replies, Prefill etc

step_list

StepList this step belongs to

step_type
enum

Type of Step: Question/Confirmation etc

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.