product:chat

Get campaign by ID.

get/campaigns/{id}

Request

  • Base URL
    https://chat.stream-io-api.com
  • URL
    https://chat.stream-io-api.com/campaigns/{id}
  • Auth
    • API key in header Authorization and API key in query parameter api_key and API key in header Stream-Auth-Type
    • or API key in query parameter api_key and API key in header Stream-Auth-Type

Path parameters

idstring required

The ID of the campaign (uuid)

Query parameters

prevstring

Token for the previous page of campaign users

nextstring

Token for the next page of campaign users

limitinteger

Maximum number of campaign users to return in a single request (max: 1000)

Response

Response

durationstring required

Duration of the request in milliseconds

Changes

    • breaking

      the response property / became optional for the status

    • breaking

      the response property / became optional for the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status