POST /manager/ambassadors
application/json

Body

  • 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 Required
  • lastname string Required
  • username string(nullable)
  • description string
  • motivation_letter string(nullable)
  • comment string(nullable)
  • email string(email) Required
  • email_tmp string(nullable)
  • dob string(nullable)
  • lang string
  • id_address_geocode string(nullable)
  • phone_1 string
  • phone_2 string
  • fb_account string(nullable)
  • twitter_account string(nullable)
  • instagram_account string(nullable)
  • linkedIn_account string(nullable)
  • youtube_account string(nullable)
  • tiktok_account string(nullable)
  • roles array[object]
    Hide roles attributes Show roles attributes object
    • status_role string
    • manager_role string

Responses

  • 201 application/json

    Returns the ambassador

    Hide response attributes Show response attributes object
    • id_ambassador integer(int32)
    • id_brand integer(int32)
    • date_insert string
    • date_update string
    • 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)
    • comment string(nullable)
    • email string
    • email_tmp string(nullable)
    • dob string(nullable)
    • lang string
    • phone_1 string
    • phone_2 string
    • notification_newsletter boolean
    • notification_pl_created boolean
    • notification_pl_expired boolean
    • notification_pl_blog boolean
    • email_notification_enabled boolean
    • notification_email_chat boolean
    • email_notification_delay string
    • last_notification_date string
    • notification_email_favorite_comment boolean
    • notification_email_post_comment boolean
    • notification_email_reward boolean
    • notification_email_tag boolean
    • notification_post_community boolean
    • notification_email_post_community boolean
    • last_notification_flow string(nullable)
    • gamification_score integer
    • gamification_current_level integer(nullable)
    • gamification_next_level integer(nullable)
    • gamification_level_badge string(nullable)
    • gamification_level_label string(nullable)
    • gamification_id_level string(nullable)
    • gamification_current_level_value integer
    • gamification_points integer(bigint)
    • last_date_gamification string(nullable)
    • gamification_points_init integer
    • suspicious boolean
    • suspicious_date string(nullable)
    • ignore_suspicious boolean
    • suspicious_quarantine boolean
    • optin_cgu boolean
    • optin_cgu_photos boolean
    • active integer(int32)
    • status integer(int32)
    • unsubscribe string(nullable)
    • anonymized boolean
    • last_date_connection string(nullable)
    • activation_date string(nullable)
    • validate_date string(nullable)
    • availability string(nullable)
    • unavailable boolean
    • 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)
    • tiktok_account string(nullable)
    • register_landing_url string(nullable)
    • onboarding_sequence string(nullable)
    • social_community_display boolean
    • last_contact_import string(nullable)
    • sell_token_amount string(nullable)
    • products_purchased_limit string(nullable)
    • nb_conversations integer(int32)
    • nb_diffused_publications integer(int32)
    • nb_sales integer(int32)
    • nb_chat_sales integer(int32)
    • nb_purchases integer(int32)
    • online boolean

      true: when last_action_date is less than 5 minutes ago

    • sponsored array
    • address_geocode object
      Hide address_geocode attributes Show address_geocode attributes object
      • date_insert string(date-time)
      • date_update string(date-time)
      • latitude string
      • longitude string
      • city string
      • country string
      • postcode string
      • street string
      • street2 string
      • status_role string
      • manager_role string
  • 403

    Forbidden - You don't have permission to access this route

  • 404

    Not found - The ambassador does not exist

POST /manager/ambassadors
curl \
 --request POST 'https://domain.tld/api/v2/manager/ambassadors' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --data '{"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","comment":"string","email":"hello@example.com","email_tmp":"string","dob":"string","lang":"string","id_address_geocode":"string","phone_1":"string","phone_2":"string","fb_account":"string","twitter_account":"string","instagram_account":"string","linkedIn_account":"string","youtube_account":"string","tiktok_account":"string","roles":[{"status_role":"string","manager_role":"string"}]}'
Request examples
{
  "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",
  "comment": "string",
  "email": "hello@example.com",
  "email_tmp": "string",
  "dob": "string",
  "lang": "string",
  "id_address_geocode": "string",
  "phone_1": "string",
  "phone_2": "string",
  "fb_account": "string",
  "twitter_account": "string",
  "instagram_account": "string",
  "linkedIn_account": "string",
  "youtube_account": "string",
  "tiktok_account": "string",
  "roles": [
    {
      "status_role": "string",
      "manager_role": "string"
    }
  ]
}
Response examples (201)
{
  "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",
  "comment": "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_blog": true,
  "email_notification_enabled": true,
  "notification_email_chat": true,
  "email_notification_delay": "string",
  "last_notification_date": "string",
  "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",
  "gamification_points_init": 42,
  "suspicious": true,
  "suspicious_date": "string",
  "ignore_suspicious": true,
  "suspicious_quarantine": true,
  "optin_cgu": true,
  "optin_cgu_photos": true,
  "active": 42,
  "status": 42,
  "unsubscribe": "string",
  "anonymized": true,
  "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",
  "tiktok_account": "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_conversations": 42,
  "nb_diffused_publications": 42,
  "nb_sales": 42,
  "nb_chat_sales": 42,
  "nb_purchases": 42,
  "online": true,
  "sponsored": [],
  "address_geocode": {
    "date_insert": "2025-05-04T09:42:00Z",
    "date_update": "2025-05-04T09:42:00Z",
    "latitude": "48.856614",
    "longitude": "2.3522219",
    "city": "Paris",
    "country": "France",
    "postcode": "75001",
    "street": "Rue de Rivoli",
    "street2": "Place de la Concorde",
    "status_role": "employee",
    "manager_role": "administrator"
  }
}