Skip to main content
PUT
Update capacity

Authorizations

Authorization
string
header
required

API token from cargo-ai login. Send as Authorization: Bearer <token>.

Headers

Idempotency-Key
string

Client-generated key that makes this write safe to retry. Reusing the same key with the same request returns the original response instead of creating a second record. Reusing it with a different request returns 422. A concurrent retry while the first request is still running returns 409. Keys expire after 24 hours. Not accepted on multipart file uploads. Optional: a request without one is processed as it always was.

Maximum string length: 255
Example:

"8e03978e-40d5-43e8-bc93-6894a57f9324"

Path Parameters

uuid
string<uuid>
required

Capacity identifier.

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$

Body

application/json

Request body schema.

name
string

Capacity name.

Required string length: 1 - 255
color
enum<string>

Capacity color.

Available options:
orange,
red,
purple,
green,
yellow,
grey
description
string | null

Capacity description.

Required string length: 1 - 1000
memberCapacity
number | null

Capacity per member.

allocationExpirationPolicy
Allocation expiration policy · object

Allocation expiration schedule.

modelUuid
string<uuid> | null

Model identifier for capacity mapping.

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$
idColumnSlug
string | null

Identifier column slug.

timeColumnSlug
string | null

Time column slug.

filter
Filter · object | null

Filter criteria for capacity.

Response

Update capacity

capacity
Capacity · object
required

Updated capacity details.