Update my ambassador information
This route allows the manager to update the ambassador information of the connected user. you can use different url prefixes according to the application you are using.
- /manager/me
- /widget/me
Path parameters
-
environment
string Required Values are
manager
orwidget
.
Body
-
password
string(nullable) -
password_confirmation
string(nullable) Password confirmation is required if password is set.
-
key_data
string(nullable) -
customer_id
string -
broker_id
string(nullable) -
shopify_customer_id
string(nullable) -
facebook_id
string -
google_id
string(nullable) -
apple_id
string(nullable) -
supervisor_identity
string(nullable) -
ambassador_id_referrer
string(nullable) -
id_ws
string(nullable) -
id_ws_referrer
string(nullable) -
image
string(nullable) -
gender
string -
firstname
string -
lastname
string -
username
string(nullable) -
description
string -
motivation_letter
string(nullable) -
email
string -
email_tmp
string(nullable) -
dob
string(nullable) -
lang
string -
phone_1
string -
phone_2
string -
notification_pl_created
boolean -
notification_pl_expired
boolean -
notification_pl_order
boolean -
notification_pl_blog
boolean -
notification_post_comment
boolean -
notification_community
boolean -
notification_reward
boolean -
email_notification_enabled
boolean -
browser_notification_enabled
boolean -
notification_tag
boolean -
notification_chat
boolean -
email_notification_delay
string -
last_notification_date
string -
notification_email_chat
boolean -
notification_email_post_comment
boolean -
notification_email_reward
boolean -
notification_email_tag
boolean -
notification_post_community
boolean -
optin_cgu
boolean -
optin_cgu_photos
boolean -
availability
string(nullable) -
last_action_date
string(nullable) -
is_absent
boolean -
absent_msg
string(nullable) -
fb_account
string(nullable) -
twitter_account
string(nullable) -
instagram_account
string(nullable) -
linkedIn_account
string(nullable) -
youtube_account
string(nullable) -
register_src
string(nullable) -
register_landing_url
string(nullable) -
nb_public_popliste
string(nullable) -
nb_private_popliste
string(nullable)
PATCH
/{environment}/me
curl \
--request PATCH 'https://domain.tld/api/v2/{environment}/me' \
--header "Authorization: Bearer $ACCESS_TOKEN" \
--header "Content-Type: application/json" \
--data '{"password":"string","password_confirmation":"string","key_data":"string","customer_id":"string","broker_id":"string","shopify_customer_id":"string","facebook_id":"string","google_id":"string","apple_id":"string","supervisor_identity":"string","ambassador_id_referrer":"string","id_ws":"string","id_ws_referrer":"string","image":"string","gender":"string","firstname":"string","lastname":"string","username":"string","description":"string","motivation_letter":"string","email":"string","email_tmp":"string","dob":"string","lang":"string","phone_1":"string","phone_2":"string","notification_newsletter":true,"notification_pl_created":true,"notification_pl_expired":true,"notification_pl_order":true,"notification_pl_blog":true,"notification_post_comment":true,"notification_community":true,"notification_reward":true,"notification_browser_waiting_list":true,"email_notification_enabled":true,"browser_notification_enabled":true,"notification_tag":true,"notification_chat":true,"email_notification_delay":"string","last_notification_date":"string","notification_email_chat":true,"notification_email_favorite_comment":true,"notification_email_post_comment":true,"notification_email_reward":true,"notification_email_tag":true,"notification_post_community":true,"notification_email_post_community":true,"optin_cgu":true,"optin_cgu_photos":true,"availability":"string","unavailable":true,"last_action_date":"string","is_absent":true,"absent_msg":"string","fb_account":"string","twitter_account":"string","instagram_account":"string","linkedIn_account":"string","youtube_account":"string","register_src":"string","register_landing_url":"string","nb_public_popliste":"string","nb_private_popliste":"string"}'
Request examples
{
"password": "string",
"password_confirmation": "string",
"key_data": "string",
"customer_id": "string",
"broker_id": "string",
"shopify_customer_id": "string",
"facebook_id": "string",
"google_id": "string",
"apple_id": "string",
"supervisor_identity": "string",
"ambassador_id_referrer": "string",
"id_ws": "string",
"id_ws_referrer": "string",
"image": "string",
"gender": "string",
"firstname": "string",
"lastname": "string",
"username": "string",
"description": "string",
"motivation_letter": "string",
"email": "string",
"email_tmp": "string",
"dob": "string",
"lang": "string",
"phone_1": "string",
"phone_2": "string",
"notification_newsletter": true,
"notification_pl_created": true,
"notification_pl_expired": true,
"notification_pl_order": true,
"notification_pl_blog": true,
"notification_post_comment": true,
"notification_community": true,
"notification_reward": true,
"notification_browser_waiting_list": true,
"email_notification_enabled": true,
"browser_notification_enabled": true,
"notification_tag": true,
"notification_chat": true,
"email_notification_delay": "string",
"last_notification_date": "string",
"notification_email_chat": true,
"notification_email_favorite_comment": true,
"notification_email_post_comment": true,
"notification_email_reward": true,
"notification_email_tag": true,
"notification_post_community": true,
"notification_email_post_community": true,
"optin_cgu": true,
"optin_cgu_photos": true,
"availability": "string",
"unavailable": true,
"last_action_date": "string",
"is_absent": true,
"absent_msg": "string",
"fb_account": "string",
"twitter_account": "string",
"instagram_account": "string",
"linkedIn_account": "string",
"youtube_account": "string",
"register_src": "string",
"register_landing_url": "string",
"nb_public_popliste": "string",
"nb_private_popliste": "string"
}
Response examples (200)
{
"id_ambassador": 42,
"id_brand": 42,
"date_insert": "string",
"date_update": "string",
"key_data": "string",
"customer_id": "string",
"broker_id": "string",
"shopify_customer_id": "string",
"facebook_id": "string",
"google_id": "string",
"apple_id": "string",
"supervisor_identity": "string",
"ambassador_id_referrer": "string",
"id_ws": "string",
"id_ws_referrer": "string",
"image": "string",
"gender": "string",
"firstname": "string",
"lastname": "string",
"username": "string",
"description": "string",
"motivation_letter": "string",
"email": "string",
"email_tmp": "string",
"dob": "string",
"lang": "string",
"phone_1": "string",
"phone_2": "string",
"notification_newsletter": true,
"notification_pl_created": true,
"notification_pl_expired": true,
"notification_pl_order": true,
"notification_pl_blog": true,
"notification_post_comment": true,
"notification_community": true,
"notification_reward": true,
"notification_browser_waiting_list": true,
"email_notification_enabled": true,
"browser_notification_enabled": true,
"notification_tag": true,
"notification_chat": true,
"email_notification_delay": "string",
"last_notification_date": "string",
"notification_email_chat": true,
"notification_email_favorite_comment": true,
"notification_email_post_comment": true,
"notification_email_reward": true,
"notification_email_tag": true,
"notification_post_community": true,
"notification_email_post_community": true,
"last_notification_flow": "string",
"gamification_score": 42,
"gamification_current_level": 42,
"gamification_next_level": 42,
"gamification_level_badge": "string",
"gamification_level_label": "string",
"gamification_id_level": "string",
"gamification_current_level_value": 42,
"gamification_points": 42,
"last_date_gamification": "string",
"optin_cgu": true,
"optin_cgu_photos": true,
"active": true,
"status": 42,
"unsubscribe": "string",
"last_date_connection": "string",
"activation_date": "string",
"validate_date": "string",
"availability": "string",
"unavailable": true,
"last_action_date": "string",
"is_absent": true,
"absent_msg": "string",
"fb_account": "string",
"twitter_account": "string",
"instagram_account": "string",
"linkedIn_account": "string",
"youtube_account": "string",
"register_src": "string",
"register_landing_url": "string",
"onboarding_sequence": "string",
"social_community_display": true,
"last_contact_import": "string",
"sell_token_amount": "string",
"products_purchased_limit": "string",
"nb_public_popliste": "string",
"nb_private_popliste": "string",
"chat_topics": [
42
]
}
Response examples (401)
{
"message": "Unauthorized."
}
Response examples (422)
{
"message": "field is required! (and 3 more error)",
"errors": {
"field": [
"Error message details here"
],
"additionalProperty1": [
"Error message details here"
],
"additionalProperty2": [
"Error message details here"
]
}
}