Update Outbound Settings

PUT

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 '
{
  "totalAgents": 123,
  "transcriptOptions": 123,
  "budgetTotal": 123,
  "timeZone": "<string>",
  "callingHours": [
    {
      "day": 123,
      "start": "<string>",
      "end": "<string>"
    }
  ],
  "callWebhookUrl": "<string>",
  "leadWebhookUrl": "<string>",
  "phoneNumberId": "<string>",
  "recordingTrack": 123,
  "isStopRecordingAfterTransferCall": true,
  "maximumCallAttempts": 123,
  "minimumRetryIntervalHours": 123,
  "voiceMail": "<string>",
  "bypassIVRInstruction": "<string>",
  "ringDuration": 123,
  "callTimeout": 123
}
'

import requests

url = "https://api.nlpearl.ai/v2/Pearl/{pearlId}/Settings/Outbound"

payload = {
    "totalAgents": 123,
    "transcriptOptions": 123,
    "budgetTotal": 123,
    "timeZone": "<string>",
    "callingHours": [
        {
            "day": 123,
            "start": "<string>",
            "end": "<string>"
        }
    ],
    "callWebhookUrl": "<string>",
    "leadWebhookUrl": "<string>",
    "phoneNumberId": "<string>",
    "recordingTrack": 123,
    "isStopRecordingAfterTransferCall": True,
    "maximumCallAttempts": 123,
    "minimumRetryIntervalHours": 123,
    "voiceMail": "<string>",
    "bypassIVRInstruction": "<string>",
    "ringDuration": 123,
    "callTimeout": 123
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    totalAgents: 123,
    transcriptOptions: 123,
    budgetTotal: 123,
    timeZone: '<string>',
    callingHours: [{day: 123, start: '<string>', end: '<string>'}],
    callWebhookUrl: '<string>',
    leadWebhookUrl: '<string>',
    phoneNumberId: '<string>',
    recordingTrack: 123,
    isStopRecordingAfterTransferCall: true,
    maximumCallAttempts: 123,
    minimumRetryIntervalHours: 123,
    voiceMail: '<string>',
    bypassIVRInstruction: '<string>',
    ringDuration: 123,
    callTimeout: 123
  })
};

fetch('https://api.nlpearl.ai/v2/Pearl/{pearlId}/Settings/Outbound', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.nlpearl.ai/v2/Pearl/{pearlId}/Settings/Outbound",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'totalAgents' => 123,
    'transcriptOptions' => 123,
    'budgetTotal' => 123,
    'timeZone' => '<string>',
    'callingHours' => [
        [
                'day' => 123,
                'start' => '<string>',
                'end' => '<string>'
        ]
    ],
    'callWebhookUrl' => '<string>',
    'leadWebhookUrl' => '<string>',
    'phoneNumberId' => '<string>',
    'recordingTrack' => 123,
    'isStopRecordingAfterTransferCall' => true,
    'maximumCallAttempts' => 123,
    'minimumRetryIntervalHours' => 123,
    'voiceMail' => '<string>',
    'bypassIVRInstruction' => '<string>',
    'ringDuration' => 123,
    'callTimeout' => 123
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.nlpearl.ai/v2/Pearl/{pearlId}/Settings/Outbound"

	payload := strings.NewReader("{\n  \"totalAgents\": 123,\n  \"transcriptOptions\": 123,\n  \"budgetTotal\": 123,\n  \"timeZone\": \"<string>\",\n  \"callingHours\": [\n    {\n      \"day\": 123,\n      \"start\": \"<string>\",\n      \"end\": \"<string>\"\n    }\n  ],\n  \"callWebhookUrl\": \"<string>\",\n  \"leadWebhookUrl\": \"<string>\",\n  \"phoneNumberId\": \"<string>\",\n  \"recordingTrack\": 123,\n  \"isStopRecordingAfterTransferCall\": true,\n  \"maximumCallAttempts\": 123,\n  \"minimumRetryIntervalHours\": 123,\n  \"voiceMail\": \"<string>\",\n  \"bypassIVRInstruction\": \"<string>\",\n  \"ringDuration\": 123,\n  \"callTimeout\": 123\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.put("https://api.nlpearl.ai/v2/Pearl/{pearlId}/Settings/Outbound")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"totalAgents\": 123,\n  \"transcriptOptions\": 123,\n  \"budgetTotal\": 123,\n  \"timeZone\": \"<string>\",\n  \"callingHours\": [\n    {\n      \"day\": 123,\n      \"start\": \"<string>\",\n      \"end\": \"<string>\"\n    }\n  ],\n  \"callWebhookUrl\": \"<string>\",\n  \"leadWebhookUrl\": \"<string>\",\n  \"phoneNumberId\": \"<string>\",\n  \"recordingTrack\": 123,\n  \"isStopRecordingAfterTransferCall\": true,\n  \"maximumCallAttempts\": 123,\n  \"minimumRetryIntervalHours\": 123,\n  \"voiceMail\": \"<string>\",\n  \"bypassIVRInstruction\": \"<string>\",\n  \"ringDuration\": 123,\n  \"callTimeout\": 123\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.nlpearl.ai/v2/Pearl/{pearlId}/Settings/Outbound")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"totalAgents\": 123,\n  \"transcriptOptions\": 123,\n  \"budgetTotal\": 123,\n  \"timeZone\": \"<string>\",\n  \"callingHours\": [\n    {\n      \"day\": 123,\n      \"start\": \"<string>\",\n      \"end\": \"<string>\"\n    }\n  ],\n  \"callWebhookUrl\": \"<string>\",\n  \"leadWebhookUrl\": \"<string>\",\n  \"phoneNumberId\": \"<string>\",\n  \"recordingTrack\": 123,\n  \"isStopRecordingAfterTransferCall\": true,\n  \"maximumCallAttempts\": 123,\n  \"minimumRetryIntervalHours\": 123,\n  \"voiceMail\": \"<string>\",\n  \"bypassIVRInstruction\": \"<string>\",\n  \"ringDuration\": 123,\n  \"callTimeout\": 123\n}"

response = http.request(request)
puts response.read_body

true

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "instance": "<string>",
  "errors": {}
}

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.

Outbound settings of a voice Pearl.

totalAgents

integer<int32>

Total number of agents allocated to this outbound activity.

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

callingHours

object[] | null

Allowed calling hours for the outbound activity.

Show child attributes

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

phoneNumberId

string | null

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

recordingTrack

integer<int32>

1 - Pearl

2 - Inbound

3 - Both

4 - None

isStopRecordingAfterTransferCall

boolean | null

Indicates whether recording should continue after a call is transferred.

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

voiceMail

string | null

🧩 May support variables

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

bypassIVRInstruction

string | null

🧩 May support variables

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

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.

Response

Outbound settings updated successfully.

The response is of type boolean.

Get Pearl CredentialsRetrieves the API credentials (Id and Name only) available to the specified Pearl. Use a returned Id as the CredentialId of an API action in the Pearl flow.

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 '
{
  "totalAgents": 123,
  "transcriptOptions": 123,
  "budgetTotal": 123,
  "timeZone": "<string>",
  "callingHours": [
    {
      "day": 123,
      "start": "<string>",
      "end": "<string>"
    }
  ],
  "callWebhookUrl": "<string>",
  "leadWebhookUrl": "<string>",
  "phoneNumberId": "<string>",
  "recordingTrack": 123,
  "isStopRecordingAfterTransferCall": true,
  "maximumCallAttempts": 123,
  "minimumRetryIntervalHours": 123,
  "voiceMail": "<string>",
  "bypassIVRInstruction": "<string>",
  "ringDuration": 123,
  "callTimeout": 123
}
'

import requests

url = "https://api.nlpearl.ai/v2/Pearl/{pearlId}/Settings/Outbound"

payload = {
    "totalAgents": 123,
    "transcriptOptions": 123,
    "budgetTotal": 123,
    "timeZone": "<string>",
    "callingHours": [
        {
            "day": 123,
            "start": "<string>",
            "end": "<string>"
        }
    ],
    "callWebhookUrl": "<string>",
    "leadWebhookUrl": "<string>",
    "phoneNumberId": "<string>",
    "recordingTrack": 123,
    "isStopRecordingAfterTransferCall": True,
    "maximumCallAttempts": 123,
    "minimumRetryIntervalHours": 123,
    "voiceMail": "<string>",
    "bypassIVRInstruction": "<string>",
    "ringDuration": 123,
    "callTimeout": 123
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    totalAgents: 123,
    transcriptOptions: 123,
    budgetTotal: 123,
    timeZone: '<string>',
    callingHours: [{day: 123, start: '<string>', end: '<string>'}],
    callWebhookUrl: '<string>',
    leadWebhookUrl: '<string>',
    phoneNumberId: '<string>',
    recordingTrack: 123,
    isStopRecordingAfterTransferCall: true,
    maximumCallAttempts: 123,
    minimumRetryIntervalHours: 123,
    voiceMail: '<string>',
    bypassIVRInstruction: '<string>',
    ringDuration: 123,
    callTimeout: 123
  })
};

fetch('https://api.nlpearl.ai/v2/Pearl/{pearlId}/Settings/Outbound', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.nlpearl.ai/v2/Pearl/{pearlId}/Settings/Outbound",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'totalAgents' => 123,
    'transcriptOptions' => 123,
    'budgetTotal' => 123,
    'timeZone' => '<string>',
    'callingHours' => [
        [
                'day' => 123,
                'start' => '<string>',
                'end' => '<string>'
        ]
    ],
    'callWebhookUrl' => '<string>',
    'leadWebhookUrl' => '<string>',
    'phoneNumberId' => '<string>',
    'recordingTrack' => 123,
    'isStopRecordingAfterTransferCall' => true,
    'maximumCallAttempts' => 123,
    'minimumRetryIntervalHours' => 123,
    'voiceMail' => '<string>',
    'bypassIVRInstruction' => '<string>',
    'ringDuration' => 123,
    'callTimeout' => 123
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.nlpearl.ai/v2/Pearl/{pearlId}/Settings/Outbound"

	payload := strings.NewReader("{\n  \"totalAgents\": 123,\n  \"transcriptOptions\": 123,\n  \"budgetTotal\": 123,\n  \"timeZone\": \"<string>\",\n  \"callingHours\": [\n    {\n      \"day\": 123,\n      \"start\": \"<string>\",\n      \"end\": \"<string>\"\n    }\n  ],\n  \"callWebhookUrl\": \"<string>\",\n  \"leadWebhookUrl\": \"<string>\",\n  \"phoneNumberId\": \"<string>\",\n  \"recordingTrack\": 123,\n  \"isStopRecordingAfterTransferCall\": true,\n  \"maximumCallAttempts\": 123,\n  \"minimumRetryIntervalHours\": 123,\n  \"voiceMail\": \"<string>\",\n  \"bypassIVRInstruction\": \"<string>\",\n  \"ringDuration\": 123,\n  \"callTimeout\": 123\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.put("https://api.nlpearl.ai/v2/Pearl/{pearlId}/Settings/Outbound")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"totalAgents\": 123,\n  \"transcriptOptions\": 123,\n  \"budgetTotal\": 123,\n  \"timeZone\": \"<string>\",\n  \"callingHours\": [\n    {\n      \"day\": 123,\n      \"start\": \"<string>\",\n      \"end\": \"<string>\"\n    }\n  ],\n  \"callWebhookUrl\": \"<string>\",\n  \"leadWebhookUrl\": \"<string>\",\n  \"phoneNumberId\": \"<string>\",\n  \"recordingTrack\": 123,\n  \"isStopRecordingAfterTransferCall\": true,\n  \"maximumCallAttempts\": 123,\n  \"minimumRetryIntervalHours\": 123,\n  \"voiceMail\": \"<string>\",\n  \"bypassIVRInstruction\": \"<string>\",\n  \"ringDuration\": 123,\n  \"callTimeout\": 123\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.nlpearl.ai/v2/Pearl/{pearlId}/Settings/Outbound")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"totalAgents\": 123,\n  \"transcriptOptions\": 123,\n  \"budgetTotal\": 123,\n  \"timeZone\": \"<string>\",\n  \"callingHours\": [\n    {\n      \"day\": 123,\n      \"start\": \"<string>\",\n      \"end\": \"<string>\"\n    }\n  ],\n  \"callWebhookUrl\": \"<string>\",\n  \"leadWebhookUrl\": \"<string>\",\n  \"phoneNumberId\": \"<string>\",\n  \"recordingTrack\": 123,\n  \"isStopRecordingAfterTransferCall\": true,\n  \"maximumCallAttempts\": 123,\n  \"minimumRetryIntervalHours\": 123,\n  \"voiceMail\": \"<string>\",\n  \"bypassIVRInstruction\": \"<string>\",\n  \"ringDuration\": 123,\n  \"callTimeout\": 123\n}"

response = http.request(request)
puts response.read_body

true

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "instance": "<string>",
  "errors": {}
}

Getting Started

API V2

API V1

Authorizations

Path Parameters

Body

Response