v1

latestOpenAPI 3.0.12026-07-149718.6 KB

Facebook Messenger

Create a Messenger account

post/messenger

Request body

access_tokenstring required

This is the Facebook Business Page token. You can obtain the token using one of the following methods:

Linking your Facebook Business Page to your account with our Dashboard tool
Requesting a Page Access Token using the steps in the Facebook token reference

applicationsstring[]

Contains a list of application IDs which are linked to the account. <ul> <li>There is just one application allowed per an account.</li> <li>The application type must be type "messages".</li> </ul> For more information see Application API spec

external_idstring required

This is the unique identifier within the provider's domain. In this case it is the Page ID for your Facebook Page. Go to your Facebook Page, click "Settings", click "Messenger platform " scroll down to "Messenger link" to find your Page ID.

namestring

Custom account name

Example request

{
  "access_token": "myAccessToken",
  "applications": [
    "optionalApplicationId"
  ],
  "external_id": "12345678",
  "name": "optionalName"
}

Response

Created.

access_tokenstring required

The provider access token

api_keystring required

The external api key for this account

applicationsstring[]

The array of associated application ids

external_idstring required

The external identifier for this account

namestring

The account name

providerstring required

The provider (will be messenger).

Example response

{
  "access_token": "myAccessToken",
  "api_key": "abcd1234",
  "applications": [
    "optionalApplicationId"
  ],
  "external_id": "12345678",
  "name": "optionalName",
  "provider": "messenger"
}