GEgetstream
product:chat

Start/schedule campaign

Changed on

Starts or schedules a campaign

post/campaigns/{id}/start

Request

  • Base URL
    https://chat.stream-io-api.com
  • URL
    https://chat.stream-io-api.com/campaigns/{id}/start
  • 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

Request body

scheduled_forstring date-time
stop_atstring date-time

Response

Response

durationstring required

Duration of the request in milliseconds

Changes

  • 678ca18d68f0Revision changes
    • breaking

      the response property / became optional for the status

    • breaking

      the response property / became optional for the status

  • 30f95dce0284Revision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status