---
title: "Set Up Custom Attributes"
slug: "custom-attribute"
updated: 2024-11-03T19:10:24Z
published: 2024-11-03T19:10:24Z
canonical: "help.bringg.com/custom-attribute"
---

> ## Documentation Index
> Fetch the complete documentation index at: https://help.bringg.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Set Up Custom Attributes

Set up custom attributes in Bringg to customize workflows to your needs, from tracking driver certifications to marking priority orders. For example, flag VIP customers to ensure their orders receive expedited handling throughout delivery.

### Before You Begin

- Confirm you have a Bringg user of type Admin.

### Add Custom Attributes

**Step 1:** (Recommended) Add custom details under the **extras** field in your [Create Order](https://developers.bringg.com/reference/create-task) payload.

NoteThis is not a pre-requisite to adding custom attributes manually in the Bringg **Settings**, but it is recommended.  If not added to the payload, the attribute will remain empty on the order page.

**Step 2:** Add a new custom attribute by selecting your username **> Settings > Merchant Configurations > Custom Attributes > + New Attribute**.

Tip!

Bringg scans your order payloads from the last 90 days to find unmapped fields that you use often. You can add these suggested fields, by selecting +Add in their row.

![](https://cdn.document360.io/a18074ef-073a-4ab1-bcab-12625715280e/Images/Documentation/exception_customattribute_pause(1).png)Add a suggested custom attribute

**Step 3:** Enter the attribute details.

![](https://cdn.document360.io/a18074ef-073a-4ab1-bcab-12625715280e/Images/Documentation/exception_customattribute_details.jpg)Enter the attribute details

| **Field** | **Description** |
| --- | --- |
| **Entity** | Select the data group the custom attribute is related to. Currently, all custom attributes must relate to the Order entity |
| **Path** | (Recommended) Enter the attributes data path. This should match the **"field"** input in the **Create Order** payload within Extras. For example, in this payload, the **Path**is "member_info.member_id" ```json "extras": { "member_info":{ "member_id": "1234" } } ``` |
| **Display name** | Enter an easily recognizable name that appears in Bringg features like the order page or filters. For example, name an attribute defining the ID or status of a customer as either "Membership ID" or "Membership Status" so that you can later filter orders by that attribute. |
| **Data type** | Select the attribute's data type so Bringg knows what options to display for it. Data types can be **Number**, **String**, **Boolean**, or **From list.** |
| **Description** | Enter a description that allows users to quickly understand what the attribute is used for. For example, you may describe which membership IDs require a different level of delivery service. |
| **Show in Driver App** | Select to display the custom attribute in the Driver App's order screen. |
| **Mandatory attribute** | Select to define a custom attribute as a mandatory field in the API payload. Once defined as mandatory, if the attribute is missing from the payload, the API call will return an error. |

**Step 4:** Select **Add Attribute** to save.

![](https://cdn.document360.io/a18074ef-073a-4ab1-bcab-12625715280e/Images/Documentation/exception_customattribute_save.png)Save the custom attribute

### Manage Custom Attributes

Select the ellipses icon to **edit** or **delete** an existing attribute.

![](https://cdn.document360.io/a18074ef-073a-4ab1-bcab-12625715280e/Images/Documentation/exception_customattribute_edit.png)Edit or delete a custom attribute

### Implement Your Custom Attributes

Use the custom attribute as options in various Bringg features, such as:

- Details in the order pages to understand how the order or its inventory is classified.
- Columns and filters in the **Dispatch** and **Planning** views to see orders with those specific attributes.
- Displaying in Bringg Driver App.
- **Triggers**, **Conditions**, or Update Order **Actions** in [Automations](/v1/docs/automate-workflows-with-automations).
- Elements that can be updated by [custom actions](/v1/docs/set-up-custom-actions-with-automations) and viewed in the **Order Activity Log**.

![](https://cdn.document360.io/a18074ef-073a-4ab1-bcab-12625715280e/Images/Documentation/exception_customattribute_usage.png)Use custom attributes throughout Bringg