Look up, search, create, update, tag and set custom field values on subscribers. 15 operations. A subscriber carries per-channel identity fields for Messenger, Instagram, WhatsApp, email and SMS on one record. Search operations are hard-capped at 100 results with no pagination or cursor, so a full result set is unreachable through the API when the cap is hit.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/manychat-subscriber-api"curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: ManyChat Subscriber API
description: Help article is available here
version: beta
servers:
- url: ''
tags:
- name: Subscriber
paths:
/fb/subscriber/getInfo:
get:
tags:
- Subscriber
summary: Ae51a27b65b7ecf39438af38db0f27ba
description: '***Limit:*** 10 queries per second'
operationId: ae51a27b65b7ecf39438af38db0f27ba
parameters:
- name: subscriber_id
in: query
description: Get subscriber info.
required: true
schema:
type: integer
responses:
'200':
description: ''
content:
application/json:
schema:
properties:
status:
type: string
example: success
isRequired: true
data:
$ref: '#/components/schemas/Subscriber'
type: object
security:
- Bearer: []
x-summary-source: derived
/fb/subscriber/findByName:
get:
tags:
- Subscriber
summary: E5c671d1661acff9be0e8bcfdd59f1e8
description: '***Limit:*** 10 queries per second.
This API method search subscribers by full name.
List is limited by 100 subscribers.'
operationId: e5c671d1661acff9be0e8bcfdd59f1e8
parameters:
- name: name
in: query
description: ''
required: true
schema:
type: string
responses:
'200':
description: ''
content:
application/json:
schema:
properties:
status:
type: string
example: success
isRequired: true
data:
type: array
items:
$ref: '#/components/schemas/Subscriber'
maxItems: 100
isRequired: true
type: object
security:
- Bearer: []
x-summary-source: derived
/fb/subscriber/getInfoByUserRef:
get:
tags:
- Subscriber
summary: 782cc8abe7878dc73026b6bef44f14b2
operationId: 782cc8abe7878dc73026b6bef44f14b2
parameters:
- name: user_ref
in: query
description: Ref of subscriber
required: true
schema:
type: integer
responses:
'200':
description: ''
content:
application/json:
schema:
properties:
status:
type: string
example: success
isRequired: true
data:
$ref: '#/components/schemas/Subscriber'
type: object
'400':
description: Possible error codes:<br>2011 - User_ref isn't registered<br>2012 - User_ref has not been linked with subscriber_id
content:
application/json:
schema:
$ref: '#/components/schemas/Response_Error_With_Code'
security:
- Bearer: []
x-summary-source: derived
/fb/subscriber/findByCustomField:
get:
tags:
- Subscriber
summary: 9fc380dcb49bb134b9405d4269896f56
description: '***Limit:*** 10 queries per second.
This API method only works with Text and Number types of Custom User Fields.
Results are sorted by last Custom User Field value update for a specific user.
List is limited by 100 elements.'
operationId: 9fc380dcb49bb134b9405d4269896f56
parameters:
- name: field_id
in: query
description: ''
required: true
schema:
type: integer
- name: field_value
in: query
description: ''
required: true
schema:
type: string
responses:
'200':
description: ''
content:
application/json:
schema:
properties:
status:
type: string
example: success
isRequired: true
data:
type: array
items:
$ref: '#/components/schemas/Subscriber'
maxItems: 100
isRequired: true
type: object
'400':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/Response_Error'
security:
- Bearer: []
x-summary-source: derived
/fb/subscriber/findBySystemField:
get:
tags:
- Subscriber
summary: Ef59064a933ef7464083a39c520a274b
description: '***Limit:*** 50 queries per second.
Set one parameter: Email OR Phone.'
operationId: ef59064a933ef7464083a39c520a274b
parameters:
- name: email
in: query
description: 'E-Mail (example: test@manychat.com)'
schema:
type: string
- name: phone
in: query
description: 'Phone number (example: +15400000000)'
schema:
type: string
responses:
'200':
description: ''
content:
application/json:
schema:
properties:
status:
type: string
example: success
isRequired: true
data:
$ref: '#/components/schemas/Subscriber'
type: object
security:
- Bearer: []
x-summary-source: derived
/fb/subscriber/addTag:
post:
tags:
- Subscriber
summary: Add tag to subscriber
description: '***Limit:*** 10 queries per second'
operationId: ee797ad59ec8545bed43add11390b165
requestBody:
required: true
content:
application/json:
schema:
required:
- subscriber_id
- tag_id
properties:
subscriber_id:
type: integer
isRequired: true
tag_id:
type: integer
isRequired: true
type: object
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/Response_Success'
'400':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/Response_Error'
security:
- Bearer: []
/fb/subscriber/addTagByName:
post:
tags:
- Subscriber
summary: Add tag to subscriber
description: '***Limit:*** 10 queries per second'
operationId: 34ad004a12043ccbfee2faf1d290d30f
requestBody:
required: true
content:
application/json:
schema:
required:
- subscriber_id
- tag_name
properties:
subscriber_id:
type: integer
isRequired: true
tag_name:
type: string
isRequired: true
type: object
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/Response_Success'
'400':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/Response_Error'
security:
- Bearer: []
/fb/subscriber/removeTag:
post:
tags:
- Subscriber
summary: Remove tag from subscriber
description: '***Limit:*** 10 queries per second'
operationId: 09f35f7c1e6013311f36e3965dec650c
requestBody:
required: true
content:
application/json:
schema:
required:
- subscriber_id
- tag_id
properties:
subscriber_id:
type: integer
isRequired: true
tag_id:
type: integer
isRequired: true
type: object
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/Response_Success'
'400':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/Response_Error'
security:
- Bearer: []
/fb/subscriber/removeTagByName:
post:
tags:
- Subscriber
summary: Remove tag from subscriber
description: '***Limit:*** 10 queries per second'
operationId: 59cef9685d8978968b28376db0123be4
requestBody:
required: true
content:
application/json:
schema:
required:
- subscriber_id
- tag_name
properties:
subscriber_id:
type: integer
isRequired: true
tag_name:
type: string
isRequired: true
type: object
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/Response_Success'
'400':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/Response_Error'
security:
- Bearer: []
/fb/subscriber/setCustomField:
post:
tags:
- Subscriber
summary: 81138a426b0903687848fdf8bdde6aa9
description: '***Limit:*** 10 queries per second'
operationId: 81138a426b0903687848fdf8bdde6aa9
requestBody:
description: 'Depending on the type of Custom User Field you will need to use one of the following type of data for "field_value".<br>
***For example:***<br>
Text: "text" (string)<br>
Number: 123 or 1.23 (integer or float)<br>
Boolean: true or false (boolean)<br>
Date: "2018-07-18" (string)<br>
Date and time: "2018-07-02T00:00:00+00:00" (string)<br>
<br>
Data and time format for this API method is YYYY-MM-DDTHH:MM:SSP. Where P is user’s timezone. For example May 1st 2018 06:30:24 UTC+3:00 should be formatted as 2018-05-01T06:30:24+03:00'
required: true
content:
application/json:
schema:
required:
- subscriber_id
- field_id
- field_value
properties:
subscriber_id:
type: integer
isRequired: true
field_id:
type: integer
isRequired: true
field_value:
description: string, integer or boolean (see method description)
example: '''string'', 123, true, ''2018-07-18'', ''2018-07-02T00:00:00+00:00'''
isRequired: true
type: object
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/Response_Success'
'400':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/Response_Error'
security:
- Bearer: []
x-summary-source: derived
/fb/subscriber/setCustomFields:
post:
tags:
- Subscriber
summary: 4d01076149250e9e47f3b8aa7dc53baa
description: '***Limit:*** 10 queries per second'
operationId: 4d01076149250e9e47f3b8aa7dc53baa
requestBody:
description: 'Set multiple custom fields for a single subscriber.<br>
The number of custom fields is limited to 20 for one request.<br>
Use **field_id** OR **field_name** to specify the field.<br>
***For example:***<br>
<br>
```"fields": [{"field_id": 77777777, "field_value": 555}, {"field_name": "count", "field_value": 12}]```'
required: true
content:
application/json:
schema:
required:
- subscriber_id
- fields
properties:
subscriber_id:
type: integer
isRequired: true
fields:
type: array
items:
required:
- field_id
- field_name
- field_value
properties:
field_id:
type: integer
isRequired: true
field_name:
type: string
isRequired: true
field_value:
description: string, integer or boolean (see method description)
example: '''string'', 123, true, ''2018-07-18'', ''2018-07-02T00:00:00+00:00'''
isRequired: true
type: object
additionalProperties: false
isRequired: true
type: object
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/Response_Success'
'400':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/Response_Error'
security:
- Bearer: []
x-summary-source: derived
/fb/subscriber/setCustomFieldByName:
post:
tags:
- Subscriber
summary: Adc69e1e87197b5f31c80403a3913468
description: '***Limit:*** 10 queries per second'
operationId: adc69e1e87197b5f31c80403a3913468
requestBody:
description: 'Depending on the type of Custom User Field you will need to use one of the following type of data for "field_value".<br>
***For example:***<br>
Text: "text" (string)<br>
Number: 123 or 1.23 (integer or float)<br>
Boolean: true or false (boolean)<br>
Date: "2018-07-18" (string)<br>
Date and time: "2018-07-02T00:00:00+00:00" (string)<br>
<br>
Data and time format for this API method is YYYY-MM-DDTHH:MM:SSP. Where P is user’s timezone. For example May 1st 2018 06:30:24 UTC+3:00 should be formatted as 2018-05-01T06:30:24+03:00'
required: true
content:
application/json:
schema:
required:
- subscriber_id
- field_name
- field_value
properties:
subscriber_id:
type: integer
isRequired: true
field_name:
description: not case sensitive
type: string
isRequired: true
field_value:
description: string, integer or boolean (see method description)
example: '''string'', 123, true, ''2018-07-18'', ''2018-07-02T00:00:00+00:00'''
isRequired: true
type: object
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/Response_Success'
'400':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/Response_Error'
security:
- Bearer: []
x-summary-source: derived
/fb/subscriber/verifyBySignedRequest:
post:
tags:
- Subscriber
summary: B14c21e0143af0449cfc94e58731c5a8
description: '***Limit:*** 10 queries per second'
operationId: b14c21e0143af0449cfc94e58731c5a8
requestBody:
description: <https://developers.facebook.com/docs/messenger-platform/webview/>
required: true
content:
application/json:
schema:
required:
- subscriber_id
- signed_request
properties:
subscriber_id:
type: integer
isRequired: true
signed_request:
type: string
example: _1SXnOuwXiUrcDRxI1D6Dvr55aiNusDNMxyHb8PQe7Y.eyJhbGdvcml0aG0iOiJIT2FDLVNIQTI1NiIsImNvbW11bml0eV9pZCI6bnVsbCwiaXNzdWVkX2F0IjoxNTU5MjE8NTQxLCJtZXRhZGF0YSI6bnVsbCwicGFnZV9pZCI6MjI4NjkwMDEyNDk2MTgxOSwicHNpZCI6IjIxNzI0OTkwNDI4Njc2MjIiLCJ0aHJlYWRfcGFydGljaXBhbnRfaWRzIjpudWxsLCJ0aHJlYWRfdHlwZSI6IlVTRVJfVE9fUEFHRSIsInRpZCI1IjIxNzI0OTkwNDI4Njc2MjIifQ
isRequired: true
type: object
responses:
'200':
description: ''
content:
application/json:
schema:
properties:
status:
type: string
example: success
isRequired: true
type: object
security:
- Bearer: []
x-summary-source: derived
/fb/subscriber/createSubscriber:
post:
tags:
- Subscriber
summary: Create a Unified subscriber
description: '***Limit:*** 10 queries per second'
operationId: f42eb3580f33178fdf9d87f0c778f86e
requestBody:
description: ''
required: true
content:
application/json:
schema:
properties:
first_name:
description: First Name
type: string
isRequired: true
last_name:
description: Last Name
type: string
isRequired: true
phone:
description: Phone Number is required if Email and Whatsapp Phone properties are empty
type: string
isRequired: true
whatsapp_phone:
description: Whatsapp Phone Number is required if Email and Phone Number properties are empty
type: string
isRequired: true
email:
description: Email is required if Phone Number and Whatsapp Phone properties are empty
type: string
isRequired: true
gender:
description: Gender
type: string
isRequired: true
has_opt_in_sms:
description: Has opt-in SMS is required if property Phone Number is not empty
type: boolean
isRequired: true
has_opt_in_email:
description: Has opt-in Email is required if property Email is not empty
type: boolean
isRequired: true
consent_phrase:
description: Consent phrase is required if property `has_opt_in_sms` equal true
type: string
isRequired: true
type: object
responses:
'200':
description: ''
content:
application/json:
schema:
properties:
status:
type: string
example: success
isRequired: true
data:
$ref: '#/components/schemas/Subscriber'
type: object
'400':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/Response_Error'
security:
- Bearer: []
/fb/subscriber/updateSubscriber:
post:
tags:
- Subscriber
summary: 3ab84a004f4a5942e7a5368c2b807d19
description: '***Limit:*** 10 queries per second'
operationId: 3ab84a004f4a5942e7a5368c2b807d19
requestBody:
description: ''
required: true
content:
application/json:
schema:
required:
- subscriber_id
properties:
subscriber_id:
type: integer
isRequired: true
first_name:
description: First Name
type: string
isRequired: true
last_name:
description: Last Name
type: string
isRequired: true
phone:
description: Phone Number
type: string
isRequired: true
email:
description: Email
type: string
isRequired: true
gender:
description: Gender
type: string
isRequired: true
has_opt_in_sms:
description: Has opt-in SMS is required if property Phone Number is not empty
type: boolean
isRequired: true
has_opt_in_email:
description: Has opt-in Email is required if property Email is not empty
type: boolean
isRequired: true
consent_phrase:
description: Consent phrase is required if property Has Opt In SMS equal true
type: string
isRequired: true
type: object
responses:
'200':
description: ''
content:
application/json:
schema:
properties:
status:
type: string
example: success
isRequired: true
data:
$ref: '#/components/schemas/Subscriber'
type: object
'400':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/Response_Error'
security:
- Bearer: []
x-summary-source: derived
components:
schemas:
Tag:
description: ''
required:
- id
- name
properties:
id:
type: integer
isRequired: true
name:
type: string
isRequired: true
type: object
additionalProperties: false
Subscriber:
description: ''
required:
- id
- page_id
- user_refs
- first_name
- last_name
- name
- gender
- profile_pic
- locale
- language
- timezone
- live_chat_url
- last_input_text
- optin_phone
- phone
- optin_email
- email
- subscribed
- last_interaction
- last_seen
- is_followup_enabled
- ig_username
- ig_id
- whatsapp_phone
- whatsapp_bsuid
- whatsapp_username
- optin_whatsapp
- custom_fields
- tags
properties:
id:
type: string
isRequired: true
page_id:
description: This is Facebook Page ID
type: string
isRequired: true
user_refs:
description: array with ref of subscriber; can be empty
type: array
items:
$ref: '#/components/schemas/Subscriber_Ref_Field'
example: '[{ ''user_ref'':''-1543835812530302162'', ''opted_in'':''2018-12-03T11:17:54+00:00'' }]'
isRequired: true
first_name:
type: string
isRequired: true
last_name:
type: string
isRequired: true
name:
type: string
isRequired: true
gender:
type: string
isRequired: true
profile_pic:
type: string
isRequired: true
locale:
type: string
isRequired: true
language:
type: string
isRequired: true
timezone:
type: string
isRequired: true
live_chat_url:
type: string
isRequired: true
last_input_text:
type: string
isRequired: true
optin_phone:
type: boolean
isRequired: true
phone:
type: string
isRequired: true
optin_email:
type: boolean
isRequired: true
email:
type: string
isRequired: true
subscribed:
description: datetime in W3C format
type: string
example: '''2018-07-02T00:00:00+02:00'''
isRequired: true
last_interaction:
description: datetime in W3C format
type:
- string
- 'null'
example: '''2018-07-02T00:00:00+02:00'''
isRequired: true
last_seen:
description: datetime in W3C format
type: string
example: '''2018-07-02T00:00:00+03:00'''
isRequired: true
is_followup_enabled:
type: boolean
example: true
isRequired: true
ig_username:
type: string
example: user_name
isRequired: true
ig_id:
type: integer
example: 6384638
isRequired: true
whatsapp_phone:
type: string
isRequired: true
whatsapp_bsuid:
type:
- string
- 'null'
example: US.8234928392384832
isRequired: true
whatsapp_username:
type:
- string
- 'null'
example: '@username'
isRequired: true
optin_whatsapp:
type: boolean
example: true
isRequired: true
custom_fields:
type: array
items:
$ref: '#/components/schemas/Subscriber_Custom_Field'
isRequired: true
tags:
type: array
items:
$ref: '#/components/schemas/Tag'
isRequired: true
type: object
additionalProperties: false
Response_Error_With_Code:
description: ''
required:
- status
- message
- code
properties:
status:
type: string
example: error
isRequired: true
message:
type: string
isRequired: true
code:
type: integer
isRequired: true
type: object
additionalProperties: false
Response_Error:
description: ''
required:
- status
- message
- details
properties:
status:
type: string
example: error
isRequired: true
message:
type: string
isRequired: true
details:
required:
- messages
properties:
messages:
type: array
items:
$ref: '#/components/schemas/Response_Error_Message'
isRequired: true
type: object
additionalProperties: false
isRequired: true
type: object
additionalProperties: false
Response_Success:
description: ''
required:
- status
properties:
status:
type: string
example: success
isRequired: true
type: object
additionalProperties: false
Subscriber_Ref_Field:
description: ''
required:
- user_ref
- opted_in
properties:
user_ref:
type: string
example: '-1543835812530302162'
isRequired: true
opted_in:
description: datetime in W3C format
type: string
example: '2018-12-03T11:17:54+00:00'
isRequired: true
type: object
additionalProperties: false
Subscriber_Custom_Field:
description: ''
required:
- id
- name
- type
- description
- value
properties:
id:
type: integer
isRequired: true
name:
type: string
isRequired: true
type:
type: string
enum:
- text
- number
- date
- datetime
- boolean
isRequired: true
description:
type: string
isRequired: true
value:
description: string, integer or boolean
example: '''string'', 123, true, ''2018-07-18'', ''2018-07-02T07:45:00+03:00'''
isRequired: true
type: object
additionalProperties: false
Response_Error_Message:
description: ''
required:
- message
properties:
message:
type: string
isRequired: true
type: object
additionalProperties: false
securitySchemes:
Bearer:
type: http
name: Authorization
in: header
scheme: bearer