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)
  • register_src 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

  • sponsor object

    Additional properties are allowed.

    Hide sponsor attributes Show sponsor attributes object

    • id_ambassador integer(int32)
    • image string
    • firstname string
    • lastname string
    • username string
    • email string
    • email_tmp string
    • active integer(int32)
    • status integer(int32)
    • online boolean

      true: when last_action_date is less than 5 minutes ago

    • last_action_date string(date-time)
    • customer_id string
    • anonymized boolean
  • sponsored array[object]
    Hide sponsored attributes Show sponsored attributes object

    • id_ambassador integer(int32)
    • image string
    • firstname string
    • lastname string
    • username string
    • email string
    • email_tmp string
    • active integer(int32)
    • status integer(int32)
    • online boolean

      true: when last_action_date is less than 5 minutes ago

    • last_action_date string(date-time)
    • customer_id string
    • anonymized boolean
  • point_of_sale object

    Additional properties are allowed.

    Hide point_of_sale attributes Show point_of_sale attributes object

    • id_point_of_sale integer(int32)
    • date_insert string(nullable)
    • date_update string(nullable)
    • active boolean
    • external_id string(nullable)
    • pos_type integer(int32)
    • phone string(nullable)
    • email string(nullable)
    • external_url string(nullable)
    • members array[object]
      Hide members attributes Show members attributes object

      • id_ambassador integer(int32)
      • image string
      • firstname string
      • lastname string
      • username string
      • email string
      • email_tmp string
      • active integer(int32)
      • status integer(int32)
      • online boolean

        true: when last_action_date is less than 5 minutes ago

      • last_action_date string(date-time)
      • customer_id string
      • anonymized boolean
    • address_geocode object

      Additional properties are allowed.

      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
    • labels array[object]
      Hide labels attributes Show labels attributes object

      • id_i18n_content integer
      • lang string

        Values are en_GB, fr_FR, es_ES, or de_DE.

      • content string
    • descriptions array[object]
      Hide descriptions attributes Show descriptions attributes object

      • id_i18n_content integer
      • lang string

        Values are en_GB, fr_FR, es_ES, or de_DE.

      • content string
    • hours array[object]
      Hide hours attributes Show hours attributes object

      • id_i18n_content integer
      • lang string

        Values are en_GB, fr_FR, es_ES, or de_DE.

      • content string
  • address_geocode object

    Additional properties are allowed.

    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
    • alerts array[number]
• 401 application/json

  Unauthorized.

  Hide response attribute Show response attribute object

  • message string
• 403

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

• 404

  Not found - The ambassador does not exist

• 422 application/json

  Unprocessable Content

  Hide response attributes Show response attributes object

  • message string

    Error message.

  • errors object
    Hide errors attributes Show errors attributes object

    • field array[string]

      Error message details.

    • * array[string] Additional properties

      Error message details.