Records

Update a record

patch/api/v1/records/{id}

Request

  • Base URL: https://your-tenant.tines.com
  • URL: https://your-tenant.tines.com/api/v1/records/{id}
  • Auth: one of:
    • API key in header X-User-Token
    • HTTP bearer

Path parameters

idinteger required

The ID of the record to update

Query parameters

resolve_artifactsstring

Set to "false" to return Artifacts (large text) fields as an artifact-ID reference instead of the full contents

include_childrenstring

Set to "false" to omit child records from the response. Defaults to including full child field data

Request body

field_valuesobject[]

An array of { field_id, value } objects. Only works if the record type is editable

add_child_recordsinteger[]

Record IDs to add as child records

remove_child_recordsinteger[]

Record IDs to remove as child records

parent_record_idinteger

Record ID to link as the parent. Send null to remove the parent, omit to leave unchanged

add_case_idsinteger[]

Case IDs to link to the record (at most 5)

remove_case_idsinteger[]

Case IDs to unlink from the record (at most 5)

test_modeboolean

Set to true to only update a test record, or false to only update a live record. Returns 404 if the record's mode does not match. Omit to update the record regardless of mode

Response

Successful response

idinteger

Record result set ID

record_typeobject

Record type with id and name

recordsobject[]

Record results with id, name, and value

created_atstring

When the record was created

Changes

No recorded changes to this operation across all 1 revision of this API.