Archive a stream

POST 
/api/streams/{id}:archive

This endpoint allows you to archive a stream which has been linked to a person or budget.

Required permissions:

• settings.company: allows updating stream resources.

Request

Path Parameters

id integerrequired

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

The ID of the stream to archive

Header Parameters

Wethod-Company stringrequired

The company you want to interact with

Wethod-Version stringrequired

The API version you want to use

Responses

200

Returns the stream updated.

application/json

Schema

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

name stringrequired

Possible values: <= 255 characters

The stream name

is_default boolrequired

Whether this stream is the default one

archived_at date-time

The date and time when the resource was archived

stream_leaders

object[]

The list of stream leaders associated with this stream

Array [

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

]

stream_members

object[]

The list of stream members associated with this stream

Array [

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

member_id integerrequired

Possible values: >= 1

The ID of the person attached to the stream as member

starts_at date

The start date of the association

ends_at date

The end date of the association

]

Example (from schema)

{
  "id": 1,
  "created_at": "2026-01-09T17:32:14.550Z",
  "updated_at": "2026-01-09T17:32:14.550Z",
  "name": "Developers",
  "is_default": false,
  "archived_at": "2026-01-09T17:32:14.550Z",
  "stream_leaders": [
    {
      "id": 1,
      "created_at": "2026-01-09T17:32:14.550Z",
      "updated_at": "2026-01-09T17:32:14.550Z",
      "stream_id": 1,
      "leader_id": 1,
      "deleted_at": "2026-01-09T17:32:14.550Z"
    }
  ],
  "stream_members": [
    {
      "id": 1,
      "created_at": "2026-01-09T17:32:14.550Z",
      "updated_at": "2026-01-09T17:32:14.550Z",
      "stream_id": 1,
      "member_id": 1,
      "starts_at": "2026-01-09",
      "ends_at": "2026-01-09"
    }
  ]
}

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...