Graph API Version

Saved Message Response

Reading

A saved message response for a Facebook Page

Examples

Graph API Explorer
GET /v2.10/{saved-message-response-id} HTTP/1.1
Host: graph.facebook.com
/* PHP SDK v5.0.0 */
/* make the API call */
$request = new FacebookRequest(
  $session,
  'GET',
  '/{saved-message-response-id}'
);
$response = $request->execute();
$graphObject = $response->getGraphObject();
/* handle the result */
/* make the API call */
FB.api(
    "/{saved-message-response-id}",
    function (response) {
      if (response && !response.error) {
        /* handle the result */
      }
    }
);
/* make the API call */
new GraphRequest(
    AccessToken.getCurrentAccessToken(),
    "/{saved-message-response-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:@"/{saved-message-response-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 saved response

category

string

The message category of the saved response,

image

string

The image attached to this save response

is_enabled

bool

Toggle whether to enable the message

message

string

The message body of the saved response

title

string

The title of the saved response

Edges

EdgeDescription

macros

The position of the personalization macros used in the response,

Validation Rules

ErrorDescription
210User not visible

Creating

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

Parameters

NameDescription
category
enum{STANDARD, INSTANT_REPLY, AWAY_MESSAGE, WELCOME_MESSAGE, FOLLOW_UP, MESSENGER_CODE, REFERRAL}

The message category of the saved response, INSTANT_REPLY or AWAY_MESSAGE

Required
image
numeric string or integer

An ID of an image to use with the saved response.

is_enabled
boolean

Toggle whether to enable the message

message
string

The actual message of the saved response

Required
title
string

A title for the saved response (optional). Shown to admins only

Return Type

This endpoint supports read-after-write and will read the node represented by id in the return type.
Struct {
id: numeric string,
}

Validation Rules

ErrorDescription
100Invalid parameter

Updating

You can update a SavedMessageResponse by making a POST request to /{saved_message_response_id}.

Parameters

NameDescription
image
numeric string or integer

A MESSAGE_IMAGE ID to use with the saved response. File upload is also supported

message
string

The actual message of the saved response

remove_image
boolean
Default value: false

Set to true to remove the response image

title
string

A title for the saved response (optional). Shown to admins only

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 SavedMessageResponse by making a DELETE request to /{saved_message_response_id}.

Parameters

This endpoint doesn't have any parameters.

Return Type

Struct {
success: bool,
}

Validation Rules

ErrorDescription
100Invalid parameter