List note types
The kinds that the broker's team files deal notes and contact notes under: the kinds that come with BrokerPlus, as the team changed them, then the kinds the team added. A kind the team removed is not listed. Send a slug as type on a note.
query Parameters
scopedeal or contact. Without it, you get both lists, deal first.
List note types › Responses
Success
successAlways true on a successful response.
Every kind a note can have, in the order BrokerPlus shows them.
Create a note type
Adds a kind to the deal or contact list of the broker's team. BrokerPlus makes the slug from the name. If the team removed a kind with the same slug, this brings that kind back, and the notes filed under it show its name again.
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 note type › Request Body
scopedeal or contact: the list that gets the new kind.
nameThe name of the kind. 1 to 40 characters.
colorThe colour of the chip: navy, amber, slate, red, or a #rrggbb hex. Defaults to navy.
templatePlain text or HTML that a new note of this kind starts with. Unsafe HTML is removed. Send "" for none.
Create a note type › Responses
Success
successAlways true on a successful response.
The requested record.
Remove a note type
Removes a kind from the list. The notes filed under it keep their type, and BrokerPlus shows them as an unknown kind. To bring the kind back, create a kind with the same name. The response id is the slug.
path Parameters
scopeResource id.
slugResource id.
Remove a note type › Responses
Success
successAlways true on a successful response.
The requested record.
Update a note type
Changes the name, colour, or template of a kind. The slug does not change, so every note filed under the kind keeps it. Changing a kind that comes with BrokerPlus changes it for the broker's team only. Changing a builtin kind that the team removed brings it back.
path Parameters
scopeResource id.
slugResource id.
Update a note type › Request Body
nameThe name of the kind. 1 to 40 characters.
colorThe colour of the chip: navy, amber, slate, red, or a #rrggbb hex. Defaults to navy.
templatePlain text or HTML that a new note of this kind starts with. Unsafe HTML is removed. Send "" for none.
Update a note type › Responses
Success
successAlways true on a successful response.
The requested record.