Custom fields
List custom field definitions
The custom fields the brokerage keeps, with their keys, types and options, in the brokerage's order. Leads use the contact fields.
query Parameters
page1-indexed page number, up to 1000000.
page_sizeRows per page. Capped at 100.
entitySend contact or deal to list one kind. Omit it to list both.
List custom field definitions › Responses
Success
successAlways true on a successful response.
The page of results. The endpoint description and the Pagination guide give the order.
Offset pagination. Page forward until page reaches total_pages.
Create a custom field
Adds a field to every contact or every deal, the same as Settings > Custom Fields. The new field goes to the end of the order. Only a key that belongs to a brokerage admin can change custom fields. A label that makes the key of an archived field restores that field, with the answers it had.
Headers
Idempotency-KeyOptional for POST. An authorized retry with the same method, path, and exact body returns the stored response. Reservations last 24 hours. They belong to the original API key and broker. Reconcile uncertain results before you use a new key.
Create a custom field › Request Body
entityThe kind of record the field is on. A lead uses the contact fields.
labelWhat the brokerage calls the field on screen. BrokerPlus makes the field's key from it, and the key does not change when the label changes. A label that makes the key of an archived field restores that field and its answers.
typeWhat the field holds. You cannot change the type after you create the field.
optionsThe permitted values of a select or multi_select field, in the order to show them. Send the whole list. An option that is not in the list is removed, and the answers that use it stay on the records that have them. An option keeps its answers only when you send its label unchanged. Other types ignore this field.
sectionThe group to show the field under. Defaults to Custom Fields.
default_valueThe answer every new contact or deal starts with, in the same text form as PATCH /contacts/{id}/custom-fields/{key}. A select default is one of options. Send null to make new records start blank. A change applies only to records made after it.
Create a custom field › Responses
Success
successAlways true on a successful response.
The requested record.
Put custom fields in order
Sets the order of the contact fields or the deal fields, the same as a drag in Settings > Custom Fields. Admin keys only. Returns the fields of that entity in the new order.
Headers
Idempotency-KeyOptional for POST. An authorized retry with the same method, path, and exact body returns the stored response. Reservations last 24 hours. They belong to the original API key and broker. Reconcile uncertain results before you use a new key.
Put custom fields in order › Request Body
entityThe kind of record whose fields you put in order.
idsField ids in the new order, first to last. A field that is not in the list keeps its place. An id from another brokerage or entity is ignored.
Put custom fields in order › Responses
Success
successAlways true on a successful response.
The page of results. The endpoint description and the Pagination guide give the order.
Offset pagination. Page forward until page reaches total_pages.
Archive a custom field
Removes the field from every form, the same as Delete in Settings > Custom Fields. BrokerPlus keeps the answers, and the data export still contains them. To restore the field, create a field with the same label and type. Admin keys only.
path Parameters
idResource id.
Archive a custom field › Responses
Success
successAlways true on a successful response.
The requested record.
Update a custom field
Changes the label, options, group, or default of a field. You cannot change the key or the type. When you remove the option that is the default, the default becomes null. Admin keys only.
path Parameters
idResource id.
Update a custom field › Request Body
labelA new label. The key stays the same, so reads, writes, and filters continue to work.
optionsThe permitted values of a select or multi_select field, in the order to show them. Send the whole list. An option that is not in the list is removed, and the answers that use it stay on the records that have them. An option keeps its answers only when you send its label unchanged. Other types ignore this field.
sectionThe group to show the field under.
default_valueThe answer every new contact or deal starts with, in the same text form as PATCH /contacts/{id}/custom-fields/{key}. A select default is one of options. Send null to make new records start blank. A change applies only to records made after it.
Update a custom field › Responses
Success
successAlways true on a successful response.
The requested record.