Client surveys
NPS surveys sent to clients, their scores, and the alert rules a score sets off.
List NPS alert rules
The brokerage's alert rules for Net Promoter Score (NPS) answers, in their order. When a client answers a survey, every active rule whose score range holds the score runs: it alerts brokers and can add a task. Ranges can overlap. A brokerage with no rules gets the three starter rules from BrokerPlus on the first read.
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 NPS alert rules › 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 an NPS alert rule
Adds an alert rule at the end of the list. Only name, min_score, and max_score are required. The rule alerts brokers in the brokerage only.
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 an NPS alert rule › Request Body
nameThe name for the score range. 120 characters at most.
min_scoreThe lowest score the rule matches, from 0 to 10.
max_scoreThe highest score the rule matches, from 0 to 10. It must not be below min_score.
notify_ownerAlert the broker who sent the survey. Defaults to true.
broker_idsMore brokers to alert, from GET /v1/users. 25 at most. Defaults to none.
channelsHow the alert reaches each broker: in_app, email, or both. Defaults to in_app.
task_titleThe title of the task to add. Null adds no task.
task_bodyThe details of the task.
task_assignee_user_idThe broker who gets the task, from GET /v1/users. Null gives it to the broker who sent the survey.
task_due_in_daysThe days from the answer until the task is due, from 0 to 90. Defaults to 2.
is_activeFalse saves the rule stopped. Defaults to true.
Create an NPS alert rule › Responses
Success
successAlways true on a successful response.
The requested record.
Update an NPS alert rule
Changes the fields you send and keeps the others. The new range must still have min_score at or below max_score.
path Parameters
idResource id.
Update an NPS alert rule › Request Body
nameThe name for the score range. 120 characters at most.
min_scoreThe lowest score the rule matches, from 0 to 10.
max_scoreThe highest score the rule matches, from 0 to 10. It must not be below min_score.
notify_ownerAlert the broker who sent the survey. Defaults to true.
broker_idsMore brokers to alert, from GET /v1/users. 25 at most. Defaults to none.
channelsHow the alert reaches each broker: in_app, email, or both. Defaults to in_app.
task_titleThe title of the task to add. Null adds no task.
task_bodyThe details of the task.
task_assignee_user_idThe broker who gets the task, from GET /v1/users. Null gives it to the broker who sent the survey.
task_due_in_daysThe days from the answer until the task is due, from 0 to 90. Defaults to 2.
is_activeFalse saves the rule stopped. Defaults to true.
Update an NPS alert rule › Responses
Success
successAlways true on a successful response.
The requested record.
List NPS surveys
The Net Promoter Score (NPS) surveys sent to the broker's clients, newest first, with each score and comment. A survey has no updated_at, so this list takes no updated_since: to pick up new answers, send responded_since. Every answer then comes back in responded_at order.
query Parameters
page1-indexed page number, up to 1000000.
page_sizeRows per page. Capped at 100.
contact_idOnly the surveys sent to this contact.
deal_idOnly the surveys sent from this deal.
statusOnly the surveys with this status.
responded_sinceISO 8601 date-time. Only the surveys answered at or after it, oldest answer first. A value that is not ISO 8601 gets 400 VALIDATION_ERROR.
List NPS surveys › 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.
Send an NPS survey
Emails a client the NPS survey from BrokerPlus, now, from the broker's connected email. The response is the survey. A key with the no_sending limit cannot use this endpoint. 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.
Send an NPS survey › Request Body
contact_idThe client to survey. The client must have an email address, or send email.
email^(?:[A-Za-z0-9_'+\-]…The address to send it to. When it differs from the contact's email, it replaces that email when the survey is sent, as in BrokerPlus.
deal_idThe deal the survey is about, if any. The email carries the brand of that deal's team.
messageA note from the broker above the question. 2000 characters at most.
Send an NPS survey › Responses
Success
successAlways true on a successful response.
The requested record.