---
title: "Update Outbound Settings"
method: PUT
path: "/v2/Pearl/{pearlId}/Settings/Outbound"
tags: ["Pearl"]
---

# Update Outbound Settings

`PUT /v2/Pearl/{pearlId}/Settings/Outbound`

## Request

- Base URL: `https://api.nlpearl.ai`
- URL: `https://api.nlpearl.ai/v2/Pearl/{pearlId}/Settings/Outbound`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/nlpearl/apis/nlpearl-client-api/docs/v2/Pearl/:pearlId/Settings/Outbound/put.ts> (a function with typed inputs; its response is checked against the schema)

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.

## Path parameters

- `pearlId` string, required

## Request body

- OutboundVoiceSettingsApi: Outbound settings of a voice Pearl.
  - `totalAgents` integer: Total number of agents allocated to this outbound activity.
  - `transcriptOptions` integer: `1 - FullTranscript` `2 - SensitiveInfoRemoved` `3 - NoTranscript`
  - `budgetTotal` integer, nullable: Total budget allocated for the outbound activity. If null, the outbound activity runs without a budget limit.
  - `timeZone` string, 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](https://learn.microsoft.com/en-us/windows-hardware/manufacture/desktop/default-time-zones?view=windows-11). Example: "Pacific Standard Time", "Romance Standard Time".
  - `callingHours` DayWorkingHours[], nullable: Allowed calling hours for the outbound activity.
    - `day` integer: `0 - Sunday` `1 - Monday` `2 - Tuesday` `3 - Wednesday` `4 - Thursday` `5 - Friday` `6 - Saturday`
    - `start` string, date-span: Start time of the allowed calling window (based on the campaign time zone). Constraints: - Must be before End.
    - `end` string, date-span: End time of the allowed calling window (based on the campaign time zone). Constraints: - Must be after Start.
  - `callWebhookUrl` string, nullable: Optional webhook URL to receive call events (for example call started and call ended).
  - `leadWebhookUrl` string, nullable: Optional webhook URL to receive lead events (for example lead created/updated).
  - `phoneNumberId` string, nullable: The phone number ID to use for this Pearl. To retrieve available phone numbers, see: [Get Phone Numbers](/api-reference/v2/pearlSettings/get-phones)
  - `recordingTrack` integer: `1 - Pearl` `2 - Inbound` `3 - Both` `4 - None`
  - `isStopRecordingAfterTransferCall` boolean, nullable: Indicates whether recording should continue after a call is transferred.
  - `maximumCallAttempts` integer: Maximum number of call attempts per lead. Constraints: - Max 5 attempts.
  - `minimumRetryIntervalHours` integer: `1 - Every6Hours` `2 - OnceADay` `3 - OnceEvery3Days` `4 - OnceAWeek` `5 - OnceAMonth` `6 - Every3Hours`
  - `voiceMail` string, nullable: `🧩 May support variables` Voicemail message left when a voicemail/answering machine is detected. If empty, the agent will not leave voicemails.
  - `bypassIVRInstruction` string, nullable: `🧩 May support variables` Instructions used to bypass IVR (Interactive Voice Response) systems.
  - `ringDuration` integer, nullable: Ringing duration (in seconds) before considering the call unanswered. Constraints: - Min 10 seconds. - Max 50 seconds.
  - `callTimeout` integer, nullable: Maximum call duration (in minutes). The call is ended when this limit is reached. Constraints: - Min 1 minute. - Max 120 minutes.

## Response `200`

Outbound settings updated successfully.

- boolean

## Other responses

- `400`: The request is invalid or the data is malformed.

---

[API](https://skmtc.dev/nlpearl/apis/nlpearl-client-api.md) - [All operations](https://skmtc.dev/nlpearl/apis/nlpearl-client-api/llms.txt) - [OpenAPI document](https://skmtc.dev/nlpearl/apis/nlpearl-client-api/revisions/52d64fc5d6e9?raw)