Detach leader from stream

DELETE 
/api/streams/{stream_id}/leaders/{leader_id}

This endpoint allows you to detach a leader from a stream

Required permissions:

• settings.company: allows detaching leaders from 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 detach from 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

200

Leader successfully detached from the stream.

400

Validation failed

application/json

Schema

Schema

key string

Error unique key

message string

Human-readable message describing the error

failures

object[]

List of validation errors

Array [

field string

Name of the field causing the error

message string

Human-readable description of the error

]

Example (from schema)

{
  "key": "invalid_data",
  "message": "You provided invalid data. Check 'failures' for details.",
  "failures": [
    {
      "field": "string",
      "message": "string"
    }
  ]
}

401

Unauthorized

application/json

Schema

Schema

key string

Error unique key

message string

Human-readable message describing the error

Example (from schema)

{
  "key": "string",
  "message": "string"
}

403

Forbidden

application/json

Schema

Schema

key string

Error unique key

message string

Human-readable message describing the error

Example (from schema)

{
  "key": "string",
  "message": "string"
}

404

Not found

application/json

Schema

Schema

key string

Error unique key

message string

Human-readable message describing the error

Example (from schema)

{
  "key": "not_found",
  "message": "string"
}

412

Precondition failed

application/json

Schema

Schema

key string

Error unique key

message string

Human-readable message describing the error

Example (from schema)

{
  "key": "precondition_failure",
  "message": "string"
}

Loading...