Skip to main content
PUT
/
v2
/
Pearl
/
{pearlId}
/
Settings
/
Outbound
Update Outbound Settings
curl --request PUT \
  --url https://api.nlpearl.ai/v2/Pearl/{pearlId}/Settings/Outbound \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "phoneNumberId": "<string>",
  "totalAgents": 123,
  "recordingTrack": 123,
  "isStopRecordingAfterTransferCall": true,
  "transcriptOptions": 123,
  "budgetTotal": 123,
  "timeZone": "<string>",
  "maximumCallAttempts": 123,
  "minimumRetryIntervalHours": 123,
  "ringDuration": 123,
  "callTimeout": 123,
  "voiceMail": "<string>",
  "bypassIVRInstruction": "<string>",
  "callingHours": [
    {
      "day": 123,
      "start": "<string>",
      "end": "<string>"
    }
  ],
  "callWebhookUrl": "<string>",
  "leadWebhookUrl": "<string>"
}
'
true

Documentation Index

Fetch the complete documentation index at: https://developers.nlpearl.ai/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Specify the authorization token.

For more information, check out the Authorization Guide.

Path Parameters

​
pearlId
string
required

The unique identifier of the Pearl.

Body

The outbound settings to apply.

​
phoneNumberId
string | null

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

​
totalAgents
integer<int32>

Total number of agents allocated to this outbound activity.

​
recordingTrack
integer<int32>

Call recording track selection.

  • Both: Records both sides of the call (agent and lead/customer).
  • Outbound: Records only the agent side.
  • Inbound: Records only the lead/customer side.
  • None: Disables call recording.

1 - Outbound

2 - Inbound

3 - Both

4 - None

​
isStopRecordingAfterTransferCall
boolean | null

Indicates whether recording should continue after a call is transferred.

​
transcriptOptions
integer<int32>

1 - FullTranscript

2 - SensitiveInfoRemoved

3 - NoTranscript

​
budgetTotal
integer<int32> | null

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

​
timeZone
string | null

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".

​
maximumCallAttempts
integer<int32>

Maximum number of call attempts per lead.

Constraints:

  • Max 5 attempts.
​
minimumRetryIntervalHours
integer<int32>

1 - Every6Hours

2 - OnceADay

3 - OnceEvery3Days

4 - OnceAWeek

5 - OnceAMonth

6 - Every3Hours

​
ringDuration
integer<int32> | null

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

Constraints:

  • Min 10 seconds.
  • Max 50 seconds.
​
callTimeout
integer<int32> | null

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

Constraints:

  • Min 1 minute.
  • Max 120 minutes.
​
voiceMail
string | null

🧩 May support variables

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

Notes:

  • Supports pre-call variables only.
  • When a voicemail is left, the call is marked as "voicemail left" and no further retries are attempted.

Max 500 characters only.

​
bypassIVRInstruction
string | null

🧩 May support variables

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

Automatically navigates external IVR systems by detecting voice menu options and executing the appropriate DTMF inputs, enabling Pearl to reach its intended goal.

Notes:

  • Supports pre-call variables only.
  • Instructions should be clear, sequential, and action-oriented.
  • If empty, no IVR bypass will be attempted.

Example: "If prompted, press 1 for English, then press 2 for support, then press 3 for billing."

Max 500 characters only.

​
callingHours
object[] | null

Allowed calling hours for the outbound activity.

​
callWebhookUrl
string | null

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

​
leadWebhookUrl
string | null

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

Response

Outbound settings updated successfully.

The response is of type boolean.