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
| Name | In | Type | Required |
|---|---|---|---|
| subscriber_id | JSON body | integer or string | Yes |
| first_name | JSON body | string | No |
| last_name | JSON body | string | No |
| phone | JSON body | string | No |
| JSON body | string | No | |
| gender | JSON body | string | No |
| has_opt_in_sms | JSON body | boolean | No |
| has_opt_in_email | JSON body | boolean | No |
| consent_phrase | JSON body | string | No |
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:
| Field | Type | ||||||
|---|---|---|---|---|---|---|---|
| id | string | ||||||
| page_id | string | ||||||
| user_refs | array of object | ||||||
| first_name | string | ||||||
| last_name | string | ||||||
| name | string | ||||||
| gender | string or null | ||||||
| profile_pic | string or null | ||||||
| locale | string or null | ||||||
| language | string or null | ||||||
| timezone | string | ||||||
| live_chat_url | string | ||||||
| last_input_text | string or null | ||||||
| optin_phone | boolean | ||||||
| phone | string or null | ||||||
| optin_email | boolean | ||||||
| string or null | |||||||
| subscribed | string or null | ||||||
| last_interaction | string or null | ||||||
| last_seen | string or null | ||||||
| is_followup_enabled | boolean | ||||||
| ig_username | string or null | ||||||
| ig_id | integer or null | ||||||
| whatsapp_phone | string or null | ||||||
| whatsapp_bsuid | string or null | ||||||
| whatsapp_username | string or null | ||||||
| optin_whatsapp | boolean | ||||||
| custom_fields | array of object | ||||||
| tags | array of Tag
|
Errors
400Refused401Missing or invalid key429Over the operation's limit; see Retry-After
Shapes and numbered codes: Errors.