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

# Update Inbound Settings

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

## Request

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

Updates the inbound 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

- InboundVoiceSettingsApi: Inbound settings of a voice Pearl.
  - `totalAgents` integer: Total number of agents allocated to this inbound activity.
  - `transcriptOptions` integer: `1 - FullTranscript` `2 - SensitiveInfoRemoved` `3 - NoTranscript`
  - `callWebhookUrl` string, nullable: Optional webhook URL to receive call events (for example call started and call ended).
  - `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) Constraints: - A phone number cannot be assigned to more than one active inbound Pearl at the same time.
  - `recordingOptions` boolean: Enables or disables call recording.
  - `isStopRecordingAfterTransferCall` boolean, nullable: Indicates whether recording should continue after a call is transferred.
  - `waitingSentence` string, nullable: Message played to the caller when no agent is available and the caller is waiting in the queue. Max 300 characters only.
  - `isSayQueueDetails` boolean: When enabled, the caller is informed about queue details (for example how many callers are ahead) while waiting.

## Response `200`

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