Skip to main content

Attach leader to stream

POST 
/api/streams/{stream_id}/leaders/{leader_id}
warning

Requires Streams to be enabled in company settings.

This endpoint allows you to attach a leader to a stream

Required permissions:

  • settings.company: allows attaching leaders to streams.

Request​

Path Parameters

    stream_id stringrequired

    Possible values: Value must match regular expression [0-9]+

    The ID of the stream

    leader_id stringrequired

    Possible values: Value must match regular expression [0-9]+

    The ID of the person to attach to the stream as leader

Header Parameters

    Wethod-Company stringrequired

    The company you want to interact with

    Wethod-Version stringrequired

    The API version you want to use

Responses​

Leader successfully attached to the stream.

Schema

    id integerrequired

    Possible values: >= 1

    The unique identifier of the resource

    created_at date-timerequired

    The date and time when the resource was created

    updated_at date-timerequired

    The date and time when the resource was last updated

    stream_id integerrequired

    Possible values: >= 1

    The ID of the stream

    leader_id integerrequired

    Possible values: >= 1

    The ID of the person attached to the stream as leader

    deleted_at date-time

    The date and time when the resource was deleted

Loading...