Headers

• X-Popsell-Brand integer Required

  The id of the target brand

Path parameters

• ambassador integer Required

  The ambassador id

Query parameters

• sort string

  Sort chatrooms by one of the following fields

  Value is last_action_date.

• filter[last_action_date_before] string

  Retrieve chatrooms with last action date before a date

• filter[archived] boolean

  Retrieve archived chatrooms

• filter[commented] string

  Retrieve commented chatrooms

  Values are commented or not_commented.

• filter[flag] integer

  Retrieve flagged chatrooms

  Values are 1 or 2.

• filter[type_chatroom] string

  Retrieve chatrooms by type

  Values are 0 or 7.

Responses

• 200 application/json

  Returns the chatrooms of an ambassador

  Hide response attributes Show response attributes object

  • current_page integer(int32)
  • data array[object]
    Hide data attributes Show data attributes object

    • id_chatroom integer
    • ambassadors array[object]
      Hide ambassadors attributes Show ambassadors 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
      • chatroom_pivot_data array[object]
        Hide chatroom_pivot_data attributes Show chatroom_pivot_data attributes object

        • id_chatroom integer(int32)
        • id_ambassador integer(int32)
        • last_read_message integer(int32)
        • is_blocked boolean
        • archived boolean
    • date_insert string(date-time)
    • last_message_date string(date-time)
    • type_chatroom integer

      0: one to one , 7: one to many

    • type_discussion integer

      0: between members, 1: between external, 2: between members and external

    • source string

      0:direct, 1:waiting_list, 2:hot_list

    • established_dialogue string(date-time)

      true: chatrooms with at least two authors, false: chatrooms with only one author

    • last_rating object

      Additional properties are allowed.

      Hide last_rating attributes Show last_rating attributes object

      • value integer
      • comment string
    • last_summary object

      Additional properties are allowed.

      Hide last_summary attributes Show last_summary attributes object

      • date_insert string
      • summary string
      • anomaly integer
      • topic integer
    • last_message object

      Additional properties are allowed.

      Hide last_message attributes Show last_message attributes object

      • id_message integer
      • date_insert string(date-time)
      • author object

        Additional properties are allowed.

        Hide author attributes Show author 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
      • content string
      • type_message integer

        0: text, 1: picture, 2: rating, 3: product, 4: connection, 5: request, 6: unavailable, 7: video, 8: email, 9: missed

      • status_moderation integer
  • first_page_url string
  • from integer(int32)
  • last_page integer(int32)
  • last_page_url string
  • links array[object]
    Hide links attributes Show links attributes object

    • url string(nullable)
    • label string
    • active boolean
  • next_page_url string
  • path string
  • per_page integer(int32)
  • prev_page_url string(nullable)
  • to integer(int32)
  • total integer(int32)
• 401 application/json

  Unauthorized.

  Hide response attribute Show response attribute object

  • message string
• 403

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