Update Outbound Developer Settings
Changed onUpdate the developer-only outbound settings for the current customer.
This endpoint is restricted to developer users only. Customers can read some of these settings via their own outbound-settings endpoint (they drive copy and which parts of the Outbound page apply) but not change them.
Request
- Base URL: https://api.openintake.ai (the document declares no server; this is the origin it was published from)
- URL: https://api.openintake.ai/developer/outbound-developer-settings
- Auth: none declared
Request body
Set to true to relax the outbound calling window bounds for this customer from 12:00-18:00 to 08:00-22:00 firm-local. Note 08:00-22:00 extends past the 21:00 TCPA/Florida quiet-hours limit.
Set to false to drain the whole outbound queue per run and dial immediately on enqueue instead of one call per 10 minutes
Per-phone-number daily outbound call limit. Send 0 for no limit (stored as null). Omit to leave unchanged.
Percent of the day's total dial budget callback re-dials may spend; the rest is held for new leads. Send 100 for no reservation. Omit to leave unchanged.
Set to false when this customer's leads come from a trigger: hides their lead list, CSV import and manual call queueing, and rejects the lead-writing endpoints
Arm or disarm auto-queueing of uploaded never-contacted leads
Firm-local time auto-queueing starts; must be before the end
Firm-local time auto-queueing stops (exclusive); must be after the start
Minutes between auto-queued leads
Most leads auto-queued per firm-local day
Weekdays auto-queueing runs on, 0=Monday .. 6=Sunday
Arm or disarm outbound texting for this customer
Set to true to have new text conversations offer a call now or later (plus the questionnaire where offered), answered by the SMS agent
Set to true to text new leads that arrive outside call hours to book a call, sent in text hours outside call hours. Needs contact_choice_enabled
Set to true to dial a call the recipient asked for right now even outside the call window
Set to true to dial a call at a time the recipient chose even outside the call window
How many unanswered outbound calls come before the missed-call text
Minutes between the unanswered call and the missed-call text
Hours a text conversation stays open without a reply
Number outbound texts are sent from; any phone format, stored as E.164. Send an empty string to clear (fall back to the branding or platform number). Omit to leave unchanged
Set to true to read a time given by text in the person's own time zone (from their state), asking when it is unknown
Set to true to call and text each lead from the same one of the customer's outbound numbers every time
Set to true to judge calling hours in each lead's own time zone (lead_call windows, with the call windows as the location-unknown fallback) and text a lead immediately whenever they can't be called
Response
Successful Response
The customer ID
Whether this customer may set an outbound calling window wider than 12:00-18:00 firm-local (relaxes the bounds to 08:00-22:00 firm-local)
Whether outbound calls are paced at one per customer per 10 minutes. When false, the whole queue drains in one run and enqueueing dials immediately.
Per-phone-number daily outbound call limit. Null means no limit.
Share of the day's total dial budget (outbound numbers x max calls per number) that callback re-dials may spend. The rest is held for first attempts. 100 means no reservation, and it is inert when there is no per-number limit.
Whether this customer curates an outbound lead list. When false their leads come from a trigger, so the lead list, CSV import and manual call queueing are hidden and the lead-writing endpoints reject.
Whether uploaded never-contacted leads are queued automatically, one per interval
Firm-local time auto-queueing starts
Firm-local time auto-queueing stops (exclusive); unqueued rows expire then
Minutes between auto-queued leads
Most leads auto-queued per firm-local day
Weekdays auto-queueing runs on, 0=Monday .. 6=Sunday
Arm switch for outbound texting: whether texts may actually be sent (also needs the outbound_text_fallback_enabled feature flag and text contact windows)
Whether new text conversations let the recipient choose a call now or a call at a time they pick (plus the questionnaire for a firm that offers Lead Docket questionnaires), answered by the SMS agent, instead of reply-Y-for-a-link
Whether a new lead arriving outside call hours (or on a holiday) is texted to book a call, at the next moment inside text hours that is still outside call hours. Its queued call stays queued; the text can move or cancel it. Needs contact_choice_enabled
Whether a call the recipient asked for right now (by text) is dialed outside the call window
Whether a call at a time the recipient chose (on a call or by text) is dialed at that time even outside the call window
How many unanswered outbound calls come before the missed-call text
Minutes between the unanswered call and the missed-call text
Hours a text conversation stays open without a reply before it expires
E.164 number outbound texts are sent from. Null falls back to the branding info-request number, then the platform number
Whether a time the person gives by text without naming a zone is read in their own time zone (the usual one for their state), asking them when it is unknown, instead of the firm's
Whether each lead is called and texted from one of the customer's outbound numbers, the same one every time, instead of the least-used number per call and text_from_number for texts
Whether calling hours are judged in each lead's own time zone (lead_call contact windows; the call windows become the location-unknown fallback), with a lead who can't be called right now texted immediately instead of on a texting schedule
Changes
- info
added the new optional request property
- info
added the required property
to the response with the status
- info
- info
added the new optional request property
- info
added the required property
to the response with the status
- info