The brokerage's tag vocabularies. Contacts and deals have separate ones.
List contact tags
The brokerage's contact tag vocabulary. Deal tags are a separate list.
query Parameters
page1-indexed page number, up to 1000000.
page_sizeRows per page. Capped at 100.
List contact tags › 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 contact tag
Adds a tag to the brokerage's contact tag list, the same as Settings in BrokerPlus. The new tag goes to the end of the order. A name that an archived tag had restores that tag. A contact tag with is_type true is one of the brokerage's contact types.
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 contact tag › Request Body
nameThe label brokers see, 40 characters or fewer. It must be unique among the live tags of its kind.
colorThe swatch: navy, amber, slate, red, or a #rrggbb hex. Defaults to navy. Cosmetic.
is_typeContact tags only. True files the tag as one of the brokerage's contact types, in the Type row of a contact. It assigns and filters like any other tag. Defaults to false. A deal tag refuses this field.
Create a contact tag › Responses
Success
successAlways true on a successful response.
The requested record.
Archive a contact tag
Removes the tag from the list and from every contact that has it, the same as Delete in Settings. To restore the name, create a tag with the same name. The contacts do not get the tag back.
path Parameters
idResource id.
Archive a contact tag › Responses
Success
successAlways true on a successful response.
The requested record.
Update a contact tag
Changes the name or colour of a contact tag. It also moves the tag into or out of the Type row with is_type. Every contacts that has the tag keeps it.
path Parameters
idResource id.
Update a contact tag › Request Body
nameThe label brokers see, 40 characters or fewer. It must be unique among the live tags of its kind.
colorThe swatch: navy, amber, slate, red, or a #rrggbb hex. Defaults to navy. Cosmetic.
is_typeContact tags only. True files the tag as one of the brokerage's contact types, in the Type row of a contact. It assigns and filters like any other tag. Defaults to false. A deal tag refuses this field.
Update a contact tag › Responses
Success
successAlways true on a successful response.
The requested record.
List deal tags
The brokerage's deal tag vocabulary. A deal tag cannot be put on a contact.
query Parameters
page1-indexed page number, up to 1000000.
page_sizeRows per page. Capped at 100.
List deal tags › 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 deal tag
Adds a tag to the brokerage's deal tag list, the same as Settings in BrokerPlus. The new tag goes to the end of the order. A name that an archived tag had restores that tag.
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 deal tag › Request Body
nameThe label brokers see, 40 characters or fewer. It must be unique among the live tags of its kind.
colorThe swatch: navy, amber, slate, red, or a #rrggbb hex. Defaults to navy. Cosmetic.
is_typeContact tags only. True files the tag as one of the brokerage's contact types, in the Type row of a contact. It assigns and filters like any other tag. Defaults to false. A deal tag refuses this field.
Create a deal tag › Responses
Success
successAlways true on a successful response.
The requested record.
Archive a deal tag
Removes the tag from the list and from every deal that has it, the same as Delete in Settings. To restore the name, create a tag with the same name. The deals do not get the tag back.
path Parameters
idResource id.
Archive a deal tag › Responses
Success
successAlways true on a successful response.
The requested record.
Update a deal tag
Changes the name or colour of a deal tag. Every deals that has the tag keeps it.
path Parameters
idResource id.
Update a deal tag › Request Body
nameThe label brokers see, 40 characters or fewer. It must be unique among the live tags of its kind.
colorThe swatch: navy, amber, slate, red, or a #rrggbb hex. Defaults to navy. Cosmetic.
is_typeContact tags only. True files the tag as one of the brokerage's contact types, in the Type row of a contact. It assigns and filters like any other tag. Defaults to false. A deal tag refuses this field.
Update a deal tag › Responses
Success
successAlways true on a successful response.
The requested record.