USuseboom
Initiatives

Participant messages

Changed on

The participant's conversation transcript, in order. Defaults to this initiative only; pass scope="customer" for everything this person ever said to you across initiatives — use that whenever you need to know whether someone answered at all, since a reply lands on whichever initiative was live at the time and is invisible to the others.

get/api/v1/initiatives/{id}/participants/{participantId}/messages

Request

  • Base URL
    https://www.useboom.ai
  • Auth
    HTTP bearer

Path parameters

idstring required

Initiative id.

participantIdstring required

Participant id, as returned when adding or listing.

Query parameters

scope'initiative' | 'customer'

initiative (default) = only what was said under this initiative. customer = this person's whole message history across every initiative, each message tagged with the one it belongs to.

Response

Success

participantIdstring required
phoneNumberstring nullable required
channelstring required
scope'initiative' | 'customer' required
next_cursorunknown required

Changes

  • 7c7a773b12ceRevision changes
    • info

      added the new optional query request parameter scope

    • info

      added the optional property // to the response with the status

    • info

      added the required property to the response with the status