GEgetstream
product:chat

Update campaign

Changed on

Updates a campaign

put/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

Request body

create_channelsboolean
descriptionstring
idstring
namestring
segment_idsstring[]
sender_idstring required
sender_mode'exclude' | 'include'
sender_visibility'hidden' | 'archived'
show_channelsboolean
skip_pushboolean
skip_webhookboolean
user_idsstring[]

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

  • 7c37a9bae125Revision changes
    • breaking

      the response's body became nullable

    • breaking

      the response property became optional for the status

    • breaking

      the response's property type changed from array to object for status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the required property to the response with the status