Request templates
The broker's request library: the templates a broker builds to ask clients for answers, documents and signatures.
List request templates
The templates in the broker's request library, as BrokerPlus shows them when the broker asks a client for something. A team shares its broker's library. The templates that BrokerPlus supplies come first, then the most recently changed. updated_since pages on when each template last changed.
query Parameters
page1-indexed page number, up to 1000000.
page_sizeRows per page. Capped at 100.
updated_sinceISO 8601 date-time, for example 2026-10-01T00:00:00Z. Returns only rows changed at or after it, in updated_at order and then id order, oldest first. A value that is not ISO 8601 gets 400 VALIDATION_ERROR.
after_idUse with updated_since to read the next page of a sync. Send the updated_at and id of the last row you read: the list then starts after that row, and a row that changes while you sync cannot be skipped. Keep page at 1. Without updated_since it gets 400 VALIDATION_ERROR.
List request templates › 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 request template
Adds an empty template to the broker's request library. Add its items with POST /request-templates/{id}/items. To start from a template that is already there, use POST /request-templates/{id}/duplicate. Supports Idempotency-Key.
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 request template › Request Body
nameThe template's name.
descriptionWhat the template is for.
categoryThe shelf of the request library to put it on.
Create a request template › Responses
Success
successAlways true on a successful response.
The requested record.
Update a request template
Changes the name, the description or the shelf of a template, or turns its public link on or off. Only the fields you send change. Requests that were sent before do not change.
path Parameters
idResource id.
Update a request template › Request Body
nameThe template's name.
descriptionWhat the template is for. Send null to remove it.
categoryThe shelf of the request library. Send null to put it under Other.
public_link_enabledtrue turns on the public link that anybody can start a request from. The first time, this makes public_url. BrokerPlus sends the link to nobody.
Update a request template › Responses
Success
successAlways true on a successful response.
The requested record.
Copy a request template
Makes a copy of the template, with all its items, in the same library. The copy is the broker's own: it is not a template that BrokerPlus supplies, so it cannot be reset. Supports Idempotency-Key.
path Parameters
idResource id.
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.
Copy a request template › Request Body optional
nameThe name of the copy. The default is the template's name followed by (copy).
Copy a request template › Responses
Success
successAlways true on a successful response.
The requested record.
Star a request template
Stars the template for the broker your key acts as, as the star in the request library does. A star is one person's shortcut: the rest of the team does not see it. Starring a starred template changes nothing.
path Parameters
idResource id.
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.
Star a request template › Responses
Success
successAlways true on a successful response.
The requested record.
Remove the star from a request template
Removes the star of the broker your key acts as. A template with no star changes nothing.
path Parameters
idResource id.
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.
Remove the star from a request template › Responses
Success
successAlways true on a successful response.
The requested record.
Reset a request template
Puts every item that came with a template that BrokerPlus supplies back the way BrokerPlus wrote it. Items the broker added stay as they are.
path Parameters
idResource id.
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.
Reset a request template › Responses
Success
successAlways true on a successful response.
The requested record.
Add an item to a request template
Adds a question, a document to ask for, or another item to the template. A doc_request needs document_type. To add a form to sign, use BrokerPlus: the form needs its PDF. Supports Idempotency-Key.
path Parameters
idResource id.
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.
Add an item to a request template › Request Body
key^[a-z0-9_]+$ · requiredThe item's name inside the template: lowercase letters, digits and _. It must be unique on the template.
kindWhat the client is asked to do. To add a form to sign, use BrokerPlus: the form needs its PDF.
labelThe name of the item that the client reads.
positionWhere to put the item. The default is after the last item.
descriptionThe text under the name.
required_modeIf the client must do it. The default is required.
roleWho is asked. The default is either.
show_onWhich applications show the item. The default is both.
document_typeFor a doc_request, the document to ask for: a code from GET /v1/document-types, or one of the team's own document types. Required for a doc_request.
The settings for the item's kind. Copy the shape from an item of the same kind.
The conditions that show the item only for some answers.
broker_noteA note that the client sees on the item.
help_titleThe title of the item's help text.
help_body_htmlThe item's help text, as HTML. Unsafe HTML is removed.
Add an item to a request template › Responses
Success
successAlways true on a successful response.
The requested record.
Remove an item from a request template
Removes the item from the template. Requests that were sent before do not change. Removing an item that is not there returns 200.
path Parameters
idResource id.
itemIdResource id.
Remove an item from a request template › Responses
Success
successAlways true on a successful response.
The requested record.
Update an item on a request template
Changes an item on the template. Only the fields you send change. A form to sign is checked as BrokerPlus checks it: every signer must have a place to sign. To change the order of the items, use POST /request-templates/{id}/items/reorder.
path Parameters
idResource id.
itemIdResource id.
Update an item on a request template › Request Body
labelThe name of the item that the client reads.
descriptionThe text under the name.
required_modeIf the client must do it. The default is required.
roleWho is asked. The default is either.
show_onWhich applications show the item. The default is both.
document_typeFor a doc_request, the document to ask for instead. Not accepted for other kinds.
The settings for the item's kind. Copy the shape from an item of the same kind.
The conditions that show the item only for some answers.
broker_noteA note that the client sees on the item.
help_titleThe title of the item's help text.
help_body_htmlThe item's help text, as HTML. Unsafe HTML is removed.
Update an item on a request template › Responses
Success
successAlways true on a successful response.
The requested record.
Put the items of a request template in order
Sets the order of every item on the template. Send each item once, in the new order.
path Parameters
idResource id.
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 the items of a request template in order › Request Body
item_idsEvery item on the template, by id, in the new order. The first one goes first.
Put the items of a request template in order › Responses
Success
successAlways true on a successful response.
The requested record.
Reset an item on a request template
Puts one item back the way BrokerPlus wrote it, on a template that BrokerPlus supplies.
path Parameters
idResource id.
itemIdResource id.
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.
Reset an item on a request template › Responses
Success
successAlways true on a successful response.
The requested record.