Method
PUT /v1/contract-series/:id
Path Parameters
uuid
required
Contract series ID.
Body Parameters
Headers
string
Bearer token (requires
contract-series:write).string
application/jsonRequest Example
curl -X PUT "https://api.voyantcloud.com/v1/contract-series/cs_01HZYQ0RN0AT4Z2ZEYQXT4S1B2" \
-H "Authorization: Bearer $VOYANT_API_KEY" \
-H "content-type: application/json" \
-d '{
"name": "Core Contracts (2025)",
"startValue": 500,
"defaultForBe": false
}'
await fetch("https://api.voyantcloud.com/v1/contract-series/cs_01HZYQ0RN0AT4Z2ZEYQXT4S1B2", {
method: "PUT",
headers: {
Authorization: `Bearer ${process.env.VOYANT_API_KEY}`,
"content-type": "application/json",
},
body: JSON.stringify({
prefix: null,
active: false,
}),
})
import os, requests
payload = {
"pattern": "CNT-{year}-{sequence:04}",
"enforceGapless": True
}
resp = requests.put(
"https://api.voyantcloud.com/v1/contract-series/cs_01HZYQ0RN0AT4Z2ZEYQXT4S1B2",
headers={
"Authorization": f"Bearer {os.environ['VOYANT_API_KEY']}",
"content-type": "application/json",
},
json=payload,
)
updated = resp.json()
Response
{
"series": {
"id": "cs_01HZYQ0RN0AT4Z2ZEYQXT4S1B2",
"workspaceId": "ws_01HZYPM2QF2R8X9SZQ0J9SYBCN",
"name": "Core Contracts (2025)",
"prefix": null,
"pattern": "CNT-{year}-{sequence:04}",
"resetPeriod": "year",
"startValue": 500,
"enforceGapless": true,
"enforceMonotonicDates": true,
"active": false,
"defaultForBe": false,
"createdAt": "2025-01-06T10:14:32.000Z",
"updatedAt": "2025-03-22T09:41:55.000Z"
}
}
Updating
defaultForBe does not automatically set another series as default—use the Set default endpoint when promoting a series.