Skip to main content
PUT
/
v1
/
organization
/
apps
/
{appId}
/
calling
cURL
curl --request PUT \
  --url https://api.buildwithchirp.com/v1/organization/apps/{appId}/calling \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "voicemailEnabled": true,
  "voicemailGreetingUrl": "https://media.example.com/greeting.mp3",
  "voicemailMaxDuration": 120,
  "autoRecordEnabled": false,
  "recordingFormat": "mp4",
  "defaultAnswerBehavior": "webhook",
  "maxConcurrentCalls": 100,
  "whatsappCallingEnabled": false,
  "whatsappSipEnabled": false
}
'
{
  "id": "cc_2DbBs7GWhGvVNJGrDXr5RG0mBWI",
  "appId": "app_2DbBs7GWhGvVNJGrDXr5RG0mBWI",
  "organizationId": "<string>",
  "voicemailEnabled": true,
  "voicemailGreetingUrl": "<string>",
  "voicemailMaxDuration": 123,
  "autoRecordEnabled": true,
  "recordingFormat": "mp4",
  "defaultAnswerBehavior": "webhook",
  "maxConcurrentCalls": 123,
  "whatsappCallingEnabled": true,
  "whatsappSipEnabled": true,
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

Admin API key (format: sk_admin_*) for organization-level operations

Path Parameters

​
appId
string
required
Example:

"app_2DbBs7GWhGvVNJGrDXr5RG0mBWI"

Body

application/json
​
voicemailEnabled
boolean

Enable or disable voicemail for unanswered calls

Example:

true

​
voicemailGreetingUrl
string<uri> | null

URL to a custom voicemail greeting audio file

Example:

"https://media.example.com/greeting.mp3"

​
voicemailMaxDuration
integer

Maximum voicemail recording duration in seconds (10-600)

Required range: 10 <= x <= 600
Example:

120

​
autoRecordEnabled
boolean

Automatically record all calls

Example:

false

​
recordingFormat
enum<string>

Audio format for call recordings

Available options:
mp4,
ogg,
webm
Example:

"mp4"

​
defaultAnswerBehavior
enum<string>

Default behavior when a call is received: send webhook or go to voicemail

Available options:
webhook,
voicemail
Example:

"webhook"

​
maxConcurrentCalls
integer

Maximum number of simultaneous active calls (1-10000)

Required range: 1 <= x <= 10000
Example:

100

​
whatsappCallingEnabled
boolean

Enable WhatsApp calling for this app

Example:

false

​
whatsappSipEnabled
boolean

Enable WhatsApp SIP integration (requires whatsappCallingEnabled to be true)

Example:

false

Response

Calling configuration updated successfully

​
id
string
required
Example:

"cc_2DbBs7GWhGvVNJGrDXr5RG0mBWI"

​
appId
string
required
Example:

"app_2DbBs7GWhGvVNJGrDXr5RG0mBWI"

​
organizationId
string
required
​
voicemailEnabled
boolean
required
​
voicemailGreetingUrl
string | null
required
​
voicemailMaxDuration
integer
required
​
autoRecordEnabled
boolean
required
​
recordingFormat
enum<string>
required
Available options:
mp4,
ogg,
webm
​
defaultAnswerBehavior
enum<string>
required
Available options:
webhook,
voicemail
​
maxConcurrentCalls
integer
required
​
whatsappCallingEnabled
boolean
required
​
whatsappSipEnabled
boolean
required
​
createdAt
string<date-time>
required
​
updatedAt
string<date-time>
required