v1

latestOpenAPI 3.0.12026-07-2665150231.1 KB

Pearl

Update Outbound Settings

Updates the outbound settings for the specified Pearl. The update applies to the published version of the Pearl: if several versions exist on the platform, only the currently published one is modified.

put/v2/Pearl/{pearlId}/Settings/Outbound

Path parameters

pearlIdstring required

The unique identifier of the Pearl.

Request body

totalAgentsinteger

Total number of agents allocated to this outbound activity.

transcriptOptionsinteger

1 - FullTranscript

2 - SensitiveInfoRemoved

3 - NoTranscript

budgetTotalinteger nullable

Total budget allocated for the outbound activity. If null, the outbound activity runs without a budget limit.

timeZonestring nullable

Default time zone for the outbound activity.

Leads are called according to this time zone unless a lead-specific time zone is provided when adding leads. For accepted values, refer to the Windows Time Zones list.

Example: "Pacific Standard Time", "Romance Standard Time".

callWebhookUrlstring nullable

Optional webhook URL to receive call events (for example call started and call ended).

leadWebhookUrlstring nullable

Optional webhook URL to receive lead events (for example lead created/updated).

phoneNumberIdstring nullable

The phone number ID to use for this Pearl. To retrieve available phone numbers, see: Get Phone Numbers

recordingTrackinteger

1 - Pearl

2 - Inbound

3 - Both

4 - None

isStopRecordingAfterTransferCallboolean nullable

Indicates whether recording should continue after a call is transferred.

maximumCallAttemptsinteger

Maximum number of call attempts per lead.

Constraints:

Max 5 attempts.

minimumRetryIntervalHoursinteger

1 - Every6Hours

2 - OnceADay

3 - OnceEvery3Days

4 - OnceAWeek

5 - OnceAMonth

6 - Every3Hours

voiceMailstring nullable

🧩 May support variables

Voicemail message left when a voicemail/answering machine is detected. If empty, the agent will not leave voicemails.

bypassIVRInstructionstring nullable

🧩 May support variables

Instructions used to bypass IVR (Interactive Voice Response) systems.

ringDurationinteger nullable

Ringing duration (in seconds) before considering the call unanswered.

Constraints:

Min 10 seconds.
Max 50 seconds.

callTimeoutinteger nullable

Maximum call duration (in minutes). The call is ended when this limit is reached.

Constraints:

Min 1 minute.
Max 120 minutes.

Response

Outbound settings updated successfully.

boolean required