Releases API

Update a release's custom worksheet fields

PUT /api/v1/releases/:id

Discover input row IDs through GET /api/v1/custom_field_definitions, matching key: "release_budget" and custom_fieldable_type: "Release".

Send the flat row-ID-to-value map shown below, not the GET response's value.values structure. No per-record custom-field-value ID or initialization request is needed, even for a first write.

Parameters
NameDescription
id *

Numeric ID or key of the release

custom_fields

Worksheet values keyed by worksheet API key, then row ID, then input value

Example request

PUT /api/v1/releases/278327321

Example CURL command

curl "https://company.aha.io/api/v1/releases/278327321" -d '{"release":{"custom_fields":{"release_budget":{"6651670327076753738":123}}}}' -X PUT \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
contentType: application/json
accept: application/json

Request body

Response

Status: 200 OK
contentType: application/json; charset=utf-8

Response body