Contents

POST/fb/subscriber/updateSubscriber

Updates a contact's name, gender, phone or email, with consent stated for a new phone or email.

Key
The account's key, as a Bearer token
Limit
10 requests per second per key

Parameters

NameInTypeRequired
subscriber_idJSON bodyinteger or stringYes
first_nameJSON bodystringNo
last_nameJSON bodystringNo
phoneJSON bodystringNo
emailJSON bodystringNo
genderJSON bodystringNo
has_opt_in_smsJSON bodybooleanNo
has_opt_in_emailJSON bodybooleanNo
consent_phraseJSON bodystringNo

Request

curl -X POST https://engage.growthdept.ai/api/fb/subscriber/updateSubscriber \
  -H "Authorization: Bearer 1000001:YOUR_SECRET" \
  -H "Content-Type: application/json" \
  -d '{"subscriber_id":{}}'

Answer

HTTP 200 with status: "success" and data:

FieldType
idstring
page_idstring
user_refsarray of object
first_namestring
last_namestring
namestring
genderstring or null
profile_picstring or null
localestring or null
languagestring or null
timezonestring
live_chat_urlstring
last_input_textstring or null
optin_phoneboolean
phonestring or null
optin_emailboolean
emailstring or null
subscribedstring or null
last_interactionstring or null
last_seenstring or null
is_followup_enabledboolean
ig_usernamestring or null
ig_idinteger or null
whatsapp_phonestring or null
whatsapp_bsuidstring or null
whatsapp_usernamestring or null
optin_whatsappboolean
custom_fieldsarray of object
tagsarray of Tag
FieldType
id*integer
name*string

Errors

  • 400 Refused
  • 401 Missing or invalid key
  • 429 Over the operation's limit; see Retry-After

Shapes and numbered codes: Errors.