Skip to main content

Attributes

Manage custom attribute records used to extend business partner data. Create, retrieve, update, and delete attributes, and generate unique code names for new attribute definitions.

An attribute record defines a single custom field — its code name, display label, data type (via Attribute Types), and the section it belongs to (via Attribute Sections) — that can then be assigned to business partners through the PartnerAttributes resource. Alongside standard list, create, get, and update operations, a dedicated endpoint generates a unique, system-safe code name for a new attribute so integrators don't need to enforce naming-collision rules client-side.

Deletion is protected: the API rejects the request with a dedicated error if the attribute is currently in use (referenced by any PartnerAttributes value), is active, or is a predefined (non-custom) attribute, so a definition can't be removed out from under data that still depends on it.