Update Bucket

put

https://api-sandbox.thisisbud.com/aggregations/v2/buckets/{bucket_id}

Update an existing bucket (overwrites all content).

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

bucket_id

enum

required

ID of the bucket (whose criteria can be used to calculate totals).

Fixed IDs for buckets that are usable in any environment for particular use-cases (e.g. assess-dashboard for the Assess Dashboard).

Body Params

name

string

required

categorisation_model

string

required

Categorisation model that the categories in this bucket relate to.

See V2 Categories for details.

buckets

array of objects

required

length ≥ 1

buckets*

bucket_l1

string

required

criteria

array of objects

required

criteria*

additional_data

Set your own additional properties for a bucket for your own use-cases, e.g.

{
  "additional_data": {
    "display_name": "Bucket name",
    "some_custom_field": "value_1"
  }
}

Headers

X-Client-Id

string

required

The API Client Identifier (Service Application Identifier).

Responses

204

No Content

400

Bad Request

401

Unauthorized

Language

Credentials

OAuth2

Loading…