Guides
API reference
MCP server
Changelogcurl --request PATCH \
--url https://api-prod.heliyos.ai/v1/platform/records/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"data": {
"stage": "Won",
"deal_value": 52000
}
}
'const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({data: {stage: 'Won', deal_value: 52000}})
};
fetch('https://api-prod.heliyos.ai/v1/platform/records/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api-prod.heliyos.ai/v1/platform/records/{id}"
payload = { "data": {
"stage": "Won",
"deal_value": 52000
} }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text){
"meta": {
"message": "Object updated successfully"
},
"data": {
"_id": "6721c3d5e6f7a8b9c0d1e2f3",
"baseSchemaId": "66a0f1e2d3c4b5a697880003",
"organizationId": "66a0f1e2d3c4b5a697887766",
"objectType": "deals",
"data": {
"deal_name": "Northwind Traders renewal",
"stage": "Won",
"deal_value": 52000,
"close_date": "2026-12-15"
},
"relationships": [
{
"_id": "6721c3d5e6f7a8b9c0d1e2f4",
"objectId": "66f1a8c3e4b0a1b2c3d4e5f6",
"schemaId": "66a0f1e2d3c4b5a697880001",
"objectType": "company"
}
],
"metadata": {
"created": {
"at": "2026-11-02T14:10:00.000Z",
"by": "66a0f1e2d3c4b5a697881111"
},
"updated": {
"at": "2026-11-05T10:00:00.000Z",
"by": "66a0f1e2d3c4b5a697881111"
}
}
}
}{
"message": "<string>",
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"details": "<unknown>"
}
}{
"message": "<string>",
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"details": "<unknown>"
}
}{
"message": "<string>",
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"details": "<unknown>"
}
}{
"message": "<string>",
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"details": "<unknown>"
}
}{
"message": "<string>",
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"details": "<unknown>"
}
}Update a record
Changes some of a record’s field values. Send them in data, keyed by field key, with the same value
shapes as Create a record.
Fields you leave out keep their values. Each key you send replaces that one field’s value; send
null to clear a field. Required fields only need to be sent when you change them.
Permissions. Changing a field you may not edit is a 403 and writes nothing. Sending such a field
with its current value (or null for a field you may not view) is accepted and ignored, so you can
send back a whole record you read.
Links. data.relationships adds links to the records you name and never removes existing ones.
Each newly linked record gets a link back. Ids that are not records in this workspace are not
linked, and the call fails when none of the new ids is. To remove links, use
DELETE /v1/platform/records/{id}/relationships.
Side effects. Changing a company’s website rebuilds its logo (or clears it). The update fires
the <type>.updated event and, when any value changed, <type>.attribute_updated with the changed
field keys; workers can subscribe to either. A deal update sends the workspace’s deal notification
email when deal notifications are on, and synced records are updated in HubSpot. Enrichment status
cannot be changed here.
curl --request PATCH \
--url https://api-prod.heliyos.ai/v1/platform/records/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"data": {
"stage": "Won",
"deal_value": 52000
}
}
'const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({data: {stage: 'Won', deal_value: 52000}})
};
fetch('https://api-prod.heliyos.ai/v1/platform/records/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api-prod.heliyos.ai/v1/platform/records/{id}"
payload = { "data": {
"stage": "Won",
"deal_value": 52000
} }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text){
"meta": {
"message": "Object updated successfully"
},
"data": {
"_id": "6721c3d5e6f7a8b9c0d1e2f3",
"baseSchemaId": "66a0f1e2d3c4b5a697880003",
"organizationId": "66a0f1e2d3c4b5a697887766",
"objectType": "deals",
"data": {
"deal_name": "Northwind Traders renewal",
"stage": "Won",
"deal_value": 52000,
"close_date": "2026-12-15"
},
"relationships": [
{
"_id": "6721c3d5e6f7a8b9c0d1e2f4",
"objectId": "66f1a8c3e4b0a1b2c3d4e5f6",
"schemaId": "66a0f1e2d3c4b5a697880001",
"objectType": "company"
}
],
"metadata": {
"created": {
"at": "2026-11-02T14:10:00.000Z",
"by": "66a0f1e2d3c4b5a697881111"
},
"updated": {
"at": "2026-11-05T10:00:00.000Z",
"by": "66a0f1e2d3c4b5a697881111"
}
}
}
}{
"message": "<string>",
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"details": "<unknown>"
}
}{
"message": "<string>",
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"details": "<unknown>"
}
}{
"message": "<string>",
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"details": "<unknown>"
}
}{
"message": "<string>",
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"details": "<unknown>"
}
}{
"message": "<string>",
"error": {
"code": "VALIDATION_FAILED",
"message": "<string>",
"details": "<unknown>"
}
}heliyos_records_update.Authorizations
A workspace API key, sent as Authorization: Bearer heliyos_.... Create one in Heliyos under Settings → API keys. A key acts as a workspace admin in the one workspace it was created in.
Path Parameters
The record's id.
^[0-9a-fA-F]{24}$Body
The field values to change, keyed by field key, plus optional relationships. May be empty. Keys that start with $ or contain a dot are dropped. Keys that are not fields of the object are not rejected, but list and get never return them, so send field keys only.
Show child attributes
Show child attributes
Was this page helpful?