Settings

Update a custom object record

Changed on

Updates a record. Omitted fields are preserved; null clears logoUrl or externalId; supplied values replace all stored values; archived toggles archive or restore. Requires settings.manage.

patch/custom-object-records/{recordId}

Request

  • Base URL: https://api.cavuno.com/v1
  • URL: https://api.cavuno.com/v1/custom-object-records/{recordId}
  • Auth: HTTP bearer

Path parameters

recordIdstring required

Request body

namestring
slugstring

URL-safe identifier, unique within the collection. Changing it keeps the previous value reserved. Lowercase letters, numbers and single hyphens. Another record's current or previous slug is rejected with 400.

logoUrlstring uri nullable

Deprecated: use the collection's logo image field (logoFieldKey on the type). A legacy logo URL stored on older records.

externalIdstring nullable
valuesobject
archivedboolean

Response

Updated catalog record.

idstring required
object'custom_object_record' required
typeIdstring required
namestring required
slugstring nullable required

URL-safe identifier, unique within the collection. Changing it keeps the previous value reserved. Generated from the name on create; renaming keeps it. Null only on records saved before slugs existed.

logoUrlstring uri nullable required

Deprecated: use the collection's logo image field (logoFieldKey on the type). A legacy logo URL stored on older records.

externalIdstring nullable required
valuesobject required
archivedboolean required
createdAtstring date-time required

Changes

  • c34152c38176Revision changes
    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status