Update an ambassador (manager)

PATCH /manager/ambassadors/{id}

Path parameters

  • id integer Required

    The ambassador id

application/json

Responses

PATCH /manager/ambassadors/{id}
curl \
 -X PATCH https://domain.tld/api/v2/manager/ambassadors/{id} \
 -H "Authorization: Bearer $ACCESS_TOKEN" \
 -H "Content-Type: application/json" \
 -d '{"supervisor_identity":"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","notification_newsletter":true,"email_notification_enabled":true,"notification_email_chat":true,"email_notification_delay":"string","notification_email_favorite_comment":true,"notification_email_post_comment":true,"notification_email_reward":true,"notification_email_tag":true,"notification_email_post_community":true,"active":true,"activation_date":"string","validate_date":"string","availability":"string","unavailable":true,"is_absent":true,"absent_msg":"string","fb_account":"string","twitter_account":"string","instagram_account":"string","linkedIn_account":"string","youtube_account":"string","register_src":"string","social_community_display":true}'
Request examples
{
  "supervisor_identity": "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",
  "notification_newsletter": true,
  "email_notification_enabled": true,
  "notification_email_chat": true,
  "email_notification_delay": "string",
  "notification_email_favorite_comment": true,
  "notification_email_post_comment": true,
  "notification_email_reward": true,
  "notification_email_tag": true,
  "notification_email_post_community": true,
  "active": true,
  "activation_date": "string",
  "validate_date": "string",
  "availability": "string",
  "unavailable": true,
  "is_absent": true,
  "absent_msg": "string",
  "fb_account": "string",
  "twitter_account": "string",
  "instagram_account": "string",
  "linkedIn_account": "string",
  "youtube_account": "string",
  "register_src": "string",
  "social_community_display": true
}
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",
  "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",
  "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_conversations": 42,
  "nb_diffused_publications": 42,
  "nb_sales": 42,
  "nb_chat_sales": 42,
  "nb_purchases": 42,
  "online": true,
  "sponsor": {
    "id_ambassador": 42,
    "image": "string",
    "firstname": "string",
    "lastname": "string",
    "username": "string",
    "email": "string",
    "email_tmp": "string",
    "active": 42,
    "status": 42,
    "online": true,
    "last_action_date": "2024-05-04T09:42:00+00:00",
    "customer_id": "string",
    "anonymized": true
  },
  "sponsored": [
    {
      "id_ambassador": 42,
      "image": "string",
      "firstname": "string",
      "lastname": "string",
      "username": "string",
      "email": "string",
      "email_tmp": "string",
      "active": 42,
      "status": 42,
      "online": true,
      "last_action_date": "2024-05-04T09:42:00+00:00",
      "customer_id": "string",
      "anonymized": true
    }
  ],
  "role": [
    "string"
  ],
  "point_of_sale": {
    "id_point_of_sale": 42,
    "date_insert": "string",
    "date_update": "string",
    "active": true,
    "external_id": "string",
    "pos_type": 42,
    "phone": "string",
    "email": "string",
    "external_url": "string",
    "members": [
      {
        "id_ambassador": 42,
        "image": "string",
        "firstname": "string",
        "lastname": "string",
        "username": "string",
        "email": "string",
        "email_tmp": "string",
        "active": 42,
        "status": 42,
        "online": true,
        "last_action_date": "2024-05-04T09:42:00+00:00",
        "customer_id": "string",
        "anonymized": true
      }
    ],
    "address_geocode": {
      "date_insert": "2024-05-04T09:42:00+00:00",
      "date_update": "2024-05-04T09:42:00+00:00",
      "latitude": "48.856614",
      "longitude": "2.3522219",
      "city": "Paris",
      "country": "France",
      "postcode": "75001",
      "street": "Rue de Rivoli",
      "street2": "Place de la Concorde"
    },
    "labels": [
      {
        "id_i18n_content": 42,
        "lang": "en_GB",
        "content": "Hello"
      }
    ],
    "descriptions": [
      {
        "id_i18n_content": 42,
        "lang": "en_GB",
        "content": "Hello"
      }
    ],
    "hours": [
      {
        "id_i18n_content": 42,
        "lang": "en_GB",
        "content": "Hello"
      }
    ]
  },
  "address_geocode": {
    "date_insert": "2024-05-04T09:42:00+00:00",
    "date_update": "2024-05-04T09:42:00+00:00",
    "latitude": "48.856614",
    "longitude": "2.3522219",
    "city": "Paris",
    "country": "France",
    "postcode": "75001",
    "street": "Rue de Rivoli",
    "street2": "Place de la Concorde"
  }
}
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"
    ]
  }
}