Retention signals
Why to reach a past client now: an equity drop or a date of theirs, and the broker's date triggers.
List retention signals
The reasons BrokerPlus raised to reach a past client now: their loan-to-value fell below the brokerage's line, or a date of theirs is coming up. Newest first, or oldest first with updated_since.
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.
typeOnly signals of this kind.
statusOnly signals in this state.
contact_idOnly signals about this client.
deal_idOnly signals about this deal.
List retention signals › 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.
List the broker's date triggers
The dates the broker reaches clients on: their mortgage anniversary, their birthday, and the new year, with the message for each and whether it goes out on its own.
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 the broker's date triggers › 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.
Set up a date trigger
Sets up one of the broker's date triggers, switched off. Turn it on with POST /v1/pulse-triggers/{id}/turn-on. The message is the BrokerPlus default for that date. 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.
Set up a date trigger › Request Body
typeThe date to watch. The broker has at most one trigger for each.
days_offsetDays from the date to act: negative is before it, positive after, from -90 to 90. Defaults to 0, on the day.
Set up a date trigger › Responses
Success
successAlways true on a successful response.
The requested record.
Change when a date trigger acts
Moves the day a trigger acts, relative to the date. A trigger that is on stays on, and acts on the new day from its next date.
path Parameters
idResource id.
Change when a date trigger acts › Request Body
days_offsetDays from the date to act: negative is before it, positive after, from -90 to 90. Defaults to 0, on the day.
Change when a date trigger acts › Responses
Success
successAlways true on a successful response.
The requested record.
Turn on a date trigger
Turns the trigger on. From then on BrokerPlus writes to each of the broker's clients on that date, and sends it on its own when auto_send is true. A trigger that is already on is answered as it stands. A key with the no_sending limit gets 403. 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.
Turn on a date trigger › Responses
Success
successAlways true on a successful response.
The requested record.
Turn off a date trigger
Turns the trigger off, so it schedules nothing new. A message it already scheduled, up to a week ahead, still goes out: see it with GET /v1/pulse-signals?status=scheduled. A trigger that is already off is answered as it stands.
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.
Turn off a date trigger › Responses
Success
successAlways true on a successful response.
The requested record.