Reserved Names

Overview

The Delivery API reserves specific field names for internal use and standard properties. If you define a field in a content type using one of these reserved names, the API either overrides the field or excludes it from the response.

Reserved Field Names

The following field names are reserved by the Delivery API:

• name: Returns the document name.
• displayName: Returns the document display name.
• contentType: Returns the document type.
• id: Returns the document identifier.
• path: Used internally; not exposed in the Delivery API response.
• identifier: Used internally; not exposed in the Delivery API response.
• properties: Used internally; not exposed in the Delivery API response.
• property: Used internally; not exposed in the Delivery API response.
• locale: Used internally; not exposed in the Delivery API response.

Implementation Notes

• If a content type includes a field with a reserved name, the Delivery API will not expose the field as defined in the content type.
• For fields marked as "used internally," the API does not include them in the response payload.
• To avoid conflicts, use unique field names that do not match the reserved list.