Settings

Update a custom object type

Changed on

Updates its name, field definitions, or archived state. Omitted fields are preserved. Existing field types are immutable. Requires settings.manage.

patch/custom-object-types/{typeId}

Request

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

Path parameters

typeIdstring required

Request body

namestring
archivedboolean
logoFieldKeystring nullable

Key of one of the image definitions to use as the logo; null clears it. Removing that definition clears it too.

Response

Updated catalog type.

idstring required
object'custom_object_type' required
namestring required
keystring required
archivedboolean required
logoFieldKeystring nullable required

Key of the Image field whose image is each record's logo, or null when the type has no logo field.

createdAtstring date-time required

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