> ## Documentation Index
> Fetch the complete documentation index at: https://docs.pinkfish.ai/llms.txt
> Use this file to discover all available pages before exploring further.
# dialpad-admin
> Admin & Configuration
**Server path:** `/dialpad-admin` | **Type:** Application | **PCID required:** Yes
## Tools
| Tool | Description |
| ----------------------------------------------------------------------------------------------------- | ---------------------------------------------- |
| [`dialpad_admin_accesscontrolpolicies_assign`](#dialpad_admin_accesscontrolpolicies_assign) | Access Control Policies -- Assign |
| [`dialpad_admin_accesscontrolpolicies_assignments`](#dialpad_admin_accesscontrolpolicies_assignments) | Access Control Policies -- List Assignments |
| [`dialpad_admin_accesscontrolpolicies_create`](#dialpad_admin_accesscontrolpolicies_create) | Access Control Policies -- Create |
| [`dialpad_admin_accesscontrolpolicies_delete`](#dialpad_admin_accesscontrolpolicies_delete) | Access Control Policies -- Delete |
| [`dialpad_admin_accesscontrolpolicies_get`](#dialpad_admin_accesscontrolpolicies_get) | Access Control Policies -- Get |
| [`dialpad_admin_accesscontrolpolicies_list`](#dialpad_admin_accesscontrolpolicies_list) | Access Control Policies -- List Policies |
| [`dialpad_admin_accesscontrolpolicies_unassign`](#dialpad_admin_accesscontrolpolicies_unassign) | Access Control Policies -- Unassign |
| [`dialpad_admin_accesscontrolpolicies_update`](#dialpad_admin_accesscontrolpolicies_update) | Access Control Policies -- Update |
| [`dialpad_admin_app_settings_get`](#dialpad_admin_app_settings_get) | App Settings -- Get |
| [`dialpad_admin_blockednumbers_add`](#dialpad_admin_blockednumbers_add) | Blocked Number -- Add |
| [`dialpad_admin_blockednumbers_get`](#dialpad_admin_blockednumbers_get) | Blocked Number -- Get |
| [`dialpad_admin_blockednumbers_list`](#dialpad_admin_blockednumbers_list) | Blocked Numbers -- List |
| [`dialpad_admin_blockednumbers_remove`](#dialpad_admin_blockednumbers_remove) | Blocked Number -- Remove |
| [`dialpad_admin_format_post`](#dialpad_admin_format_post) | Phone String -- Reformat |
| [`dialpad_admin_numbers_assign_number_post`](#dialpad_admin_numbers_assign_number_post) | Dialpad Number -- Assign |
| [`dialpad_admin_numbers_assign_target_number_post`](#dialpad_admin_numbers_assign_target_number_post) | Dialpad Number -- Auto-Assign |
| [`dialpad_admin_numbers_delete`](#dialpad_admin_numbers_delete) | Dialpad Number -- Unassign |
| [`dialpad_admin_numbers_get`](#dialpad_admin_numbers_get) | Dialpad Number -- Get |
| [`dialpad_admin_numbers_list`](#dialpad_admin_numbers_list) | Dialpad Number -- List |
| [`dialpad_admin_numbers_swap_number_post`](#dialpad_admin_numbers_swap_number_post) | Dialpad Number -- Swap |
| [`dialpad_admin_schedule_reports_create`](#dialpad_admin_schedule_reports_create) | schedule reports -- Create |
| [`dialpad_admin_schedule_reports_delete`](#dialpad_admin_schedule_reports_delete) | Schedule reports -- Delete |
| [`dialpad_admin_schedule_reports_get`](#dialpad_admin_schedule_reports_get) | Schedule reports -- Get |
| [`dialpad_admin_schedule_reports_list`](#dialpad_admin_schedule_reports_list) | Schedule reports -- List |
| [`dialpad_admin_schedule_reports_update`](#dialpad_admin_schedule_reports_update) | Schedule reports -- Update |
| [`dialpad_admin_stats_create`](#dialpad_admin_stats_create) | Stats -- Initiate Processing |
| [`dialpad_admin_stats_get`](#dialpad_admin_stats_get) | Stats -- Get Result |
| [`dialpad_admin_tags_patch`](#dialpad_admin_tags_patch) | Number Tags -- Update tags for a phone number. |
| [`dialpad_admin_webhook_update`](#dialpad_admin_webhook_update) | Webhook -- Update |
| [`dialpad_admin_webhooks_create`](#dialpad_admin_webhooks_create) | Webhook -- Create |
| [`dialpad_admin_webhooks_delete`](#dialpad_admin_webhooks_delete) | Webhook -- Delete |
| [`dialpad_admin_webhooks_get`](#dialpad_admin_webhooks_get) | Webhook -- Get |
| [`dialpad_admin_webhooks_list`](#dialpad_admin_webhooks_list) | Webhook -- List |
| [`dialpad_admin_websockets_create`](#dialpad_admin_websockets_create) | Websocket -- Create |
| [`dialpad_admin_websockets_delete`](#dialpad_admin_websockets_delete) | Websocket -- Delete |
| [`dialpad_admin_websockets_get`](#dialpad_admin_websockets_get) | Websocket -- Get |
| [`dialpad_admin_websockets_list`](#dialpad_admin_websockets_list) | Websocket -- List |
| [`dialpad_admin_websockets_update`](#dialpad_admin_websockets_update) | Websocket -- Update |
***
## dialpad\_admin\_accesscontrolpolicies\_assign
Access Control Policies -- Assign
**Parameters:**
| Parameter | Type | Required | Default | Description | |
| ------------- | ------- | -------- | ------- | ------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- |
| `id` | integer | Yes | — | The access control policy's id. | |
| `target_id` | integer | null | No | — | Required if the policy is associated with a target (Office or Contact Center). Not required for a company level policy. |
| `target_type` | string | null | No | — | Policy permissions applied at this target level. Defaults to company target type. |
| `user_id` | integer | Yes | — | The user's id to be assigned to the policy. | |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "The access control policy's id."
},
"target_id": {
"type": [
"integer",
"null"
],
"description": "Required if the policy is associated with a target (Office or Contact Center). Not required for a company level policy."
},
"target_type": {
"type": [
"string",
"null"
],
"description": "Policy permissions applied at this target level. Defaults to company target type.",
"enum": [
"callcenter",
"company",
"department",
"office"
]
},
"user_id": {
"type": "integer",
"description": "The user's id to be assigned to the policy."
}
},
"required": [
"PCID",
"id",
"user_id"
]
}
```
***
## dialpad\_admin\_accesscontrolpolicies\_assignments
Access Control Policies -- List Assignments
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------- |
| `cursor` | string | No | — | A token used to return the next page of a previous request. Use the cursor provided in the previous response. |
| `id` | integer | Yes | — | The access control policy's id. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"cursor": {
"type": "string",
"description": "A token used to return the next page of a previous request. Use the cursor provided in the previous response."
},
"id": {
"type": "integer",
"description": "The access control policy's id."
}
},
"required": [
"PCID",
"id"
]
}
```
***
## dialpad\_admin\_accesscontrolpolicies\_create
Access Control Policies -- Create
**Parameters:**
| Parameter | Type | Required | Default | Description | |
| ----------------- | --------- | -------- | ------- | ------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- |
| `description` | string | null | No | — | \[single-line only] Optional description for the policy. Max 200 characters. |
| `name` | string | Yes | — | \[single-line only] A human-readable display name for the policy. Max 50 characters. | |
| `owner_id` | integer | Yes | — | Owner for this policy i.e company admin. | |
| `permission_sets` | string\[] | Yes | — | List of permissions associated with this policy. | |
| `target_type` | string | null | No | — | Policy permissions applied at this target level. Defaults to company target type. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"description": {
"type": [
"string",
"null"
],
"description": "[single-line only] Optional description for the policy. Max 200 characters."
},
"name": {
"type": "string",
"description": "[single-line only] A human-readable display name for the policy. Max 50 characters."
},
"owner_id": {
"type": "integer",
"description": "Owner for this policy i.e company admin."
},
"permission_sets": {
"type": "array",
"items": {
"type": "string",
"enum": [
"agent_settings_write",
"agents_admins_manage_agents_settings_write",
"agents_admins_skill_level_write",
"auto_call_recording_and_transcription_settings_write",
"business_hours_write",
"call_blocking_spam_prevention_settings_write",
"call_dispositions_settings_write",
"call_routing_hours_settings_write",
"cc_call_settings_write",
"chrome_extension_compliance_settings_write",
"csat_surveys_write",
"dashboard_and_alerts_write",
"dialpad_ai_settings_write",
"holiday_hours_settings_write",
"integrations_settings_write",
"name_language_description_settings_write",
"number_settings_write",
"supervisor_settings_write"
]
},
"description": "List of permissions associated with this policy."
},
"target_type": {
"type": [
"string",
"null"
],
"description": "Policy permissions applied at this target level. Defaults to company target type.",
"enum": [
"callcenter",
"company",
"department",
"office"
]
}
},
"required": [
"PCID",
"name",
"owner_id",
"permission_sets"
]
}
```
***
## dialpad\_admin\_accesscontrolpolicies\_delete
Access Control Policies -- Delete
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------- | -------- | ------- | ------------------------------- |
| `id` | integer | Yes | — | The access control policy's id. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "The access control policy's id."
}
},
"required": [
"PCID",
"id"
]
}
```
***
## dialpad\_admin\_accesscontrolpolicies\_get
Access Control Policies -- Get
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------- | -------- | ------- | ------------------------------- |
| `id` | integer | Yes | — | The access control policy's id. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "The access control policy's id."
}
},
"required": [
"PCID",
"id"
]
}
```
***
## dialpad\_admin\_accesscontrolpolicies\_list
Access Control Policies -- List Policies
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------------- |
| `cursor` | string | No | — | A token used to return the next page of a previous request. Use the cursor provided in the previous response. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"cursor": {
"type": "string",
"description": "A token used to return the next page of a previous request. Use the cursor provided in the previous response."
}
},
"required": [
"PCID"
]
}
```
***
## dialpad\_admin\_accesscontrolpolicies\_unassign
Access Control Policies -- Unassign
**Parameters:**
| Parameter | Type | Required | Default | Description | |
| -------------- | ------- | -------- | ------- | ----------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- |
| `id` | integer | Yes | — | The access control policy's id. | |
| `target_id` | integer | null | No | — | Required if the policy is associated with a target (Office or Contact Center). Not required for a company level policy or if unassign\_all is True. |
| `target_type` | string | null | No | — | Policy permissions applied at this target level. Defaults to company target type. |
| `unassign_all` | boolean | null | No | — | Unassign all associated target groups from the user for a policy. |
| `user_id` | integer | Yes | — | The user's id to be unassigned from the policy. | |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "The access control policy's id."
},
"target_id": {
"type": [
"integer",
"null"
],
"description": "Required if the policy is associated with a target (Office or Contact Center). Not required for a company level policy or if unassign_all is True."
},
"target_type": {
"type": [
"string",
"null"
],
"description": "Policy permissions applied at this target level. Defaults to company target type.",
"enum": [
"callcenter",
"company",
"department",
"office"
]
},
"unassign_all": {
"type": [
"boolean",
"null"
],
"description": "Unassign all associated target groups from the user for a policy."
},
"user_id": {
"type": "integer",
"description": "The user's id to be unassigned from the policy."
}
},
"required": [
"PCID",
"id",
"user_id"
]
}
```
***
## dialpad\_admin\_accesscontrolpolicies\_update
Access Control Policies -- Update
**Parameters:**
| Parameter | Type | Required | Default | Description | |
| ----------------- | --------- | -------- | ------- | ------------------------------------------------ | ------------------------------------------------------------------ |
| `id` | integer | Yes | — | The access control policy's id. | |
| `description` | string | null | No | — | \[single-line only] Optional description for the policy. |
| `name` | string | null | No | — | \[single-line only] A human-readable display name for the policy. |
| `permission_sets` | string\[] | No | — | List of permissions associated with this policy. | |
| `state` | string | null | No | — | Restore a deleted policy. |
| `user_id` | integer | null | No | — | user id updating this policy. Must be a company admin |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "The access control policy's id."
},
"description": {
"type": [
"string",
"null"
],
"description": "[single-line only] Optional description for the policy."
},
"name": {
"type": [
"string",
"null"
],
"description": "[single-line only] A human-readable display name for the policy."
},
"permission_sets": {
"type": "array",
"items": {
"type": "string",
"enum": [
"agent_settings_write",
"agents_admins_manage_agents_settings_write",
"agents_admins_skill_level_write",
"auto_call_recording_and_transcription_settings_write",
"business_hours_write",
"call_blocking_spam_prevention_settings_write",
"call_dispositions_settings_write",
"call_routing_hours_settings_write",
"cc_call_settings_write",
"chrome_extension_compliance_settings_write",
"csat_surveys_write",
"dashboard_and_alerts_write",
"dialpad_ai_settings_write",
"holiday_hours_settings_write",
"integrations_settings_write",
"name_language_description_settings_write",
"number_settings_write",
"supervisor_settings_write"
]
},
"description": "List of permissions associated with this policy."
},
"state": {
"type": [
"string",
"null"
],
"description": "Restore a deleted policy.",
"enum": [
"active"
]
},
"user_id": {
"type": [
"integer",
"null"
],
"description": "user id updating this policy. Must be a company admin"
}
},
"required": [
"PCID",
"id"
]
}
```
***
## dialpad\_admin\_app\_settings\_get
App Settings -- Get
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------- | ------- | -------- | ------- | ------------------ |
| `target_id` | integer | No | — | The target's id. |
| `target_type` | string | No | — | The target's type. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"target_id": {
"type": "integer",
"description": "The target's id."
},
"target_type": {
"type": "string",
"description": "The target's type.",
"enum": [
"callcenter",
"callrouter",
"channel",
"coachinggroup",
"coachingteam",
"department",
"office",
"room",
"staffgroup",
"unknown",
"user"
]
}
},
"required": [
"PCID"
]
}
```
***
## dialpad\_admin\_blockednumbers\_add
Blocked Number -- Add
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | --------- | -------- | ------- | --------------------------------- |
| `numbers` | string\[] | No | — | A list of E164 formatted numbers. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"numbers": {
"type": "array",
"items": {
"type": "string"
},
"description": "A list of E164 formatted numbers."
}
},
"required": [
"PCID"
]
}
```
***
## dialpad\_admin\_blockednumbers\_get
Blocked Number -- Get
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------ | -------- | ------- | ----------------------------- |
| `number` | string | Yes | — | A phone number (e164 format). |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"number": {
"type": "string",
"description": "A phone number (e164 format)."
}
},
"required": [
"PCID",
"number"
]
}
```
***
## dialpad\_admin\_blockednumbers\_list
Blocked Numbers -- List
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------------- |
| `cursor` | string | No | — | A token used to return the next page of a previous request. Use the cursor provided in the previous response. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"cursor": {
"type": "string",
"description": "A token used to return the next page of a previous request. Use the cursor provided in the previous response."
}
},
"required": [
"PCID"
]
}
```
***
## dialpad\_admin\_blockednumbers\_remove
Blocked Number -- Remove
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | --------- | -------- | ------- | --------------------------------- |
| `numbers` | string\[] | No | — | A list of E164 formatted numbers. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"numbers": {
"type": "array",
"items": {
"type": "string"
},
"description": "A list of E164 formatted numbers."
}
},
"required": [
"PCID"
]
}
```
***
## dialpad\_admin\_format\_post
Phone String -- Reformat
**Parameters:**
| Parameter | Type | Required | Default | Description |
| -------------- | ------ | -------- | ------- | ---------------------------------------------------------------------------------------------------------- |
| `country_code` | string | No | — | Country code in ISO 3166-1 alpha-2 format such as "US". Required when sending local formatted phone number |
| `number` | string | No | — | Phone number in local or E.164 format |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"country_code": {
"type": "string",
"description": "Country code in ISO 3166-1 alpha-2 format such as \"US\". Required when sending local formatted phone number"
},
"number": {
"type": "string",
"description": "Phone number in local or E.164 format"
}
},
"required": [
"PCID"
]
}
```
***
## dialpad\_admin\_numbers\_assign\_number\_post
Dialpad Number -- Assign
**Parameters:**
| Parameter | Type | Required | Default | Description | |
| ------------- | ------- | -------- | ------- | ------------------------------------------------ | ---------------------------------------------------------------------------------- |
| `number` | string | Yes | — | A specific number to assign | |
| `primary` | boolean | null | No | — | A boolean indicating whether this should become the target's primary phone number. |
| `target_id` | integer | Yes | — | The ID of the target to reassign this number to. | |
| `target_type` | string | Yes | — | The type of the target. | |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"number": {
"type": "string",
"description": "A specific number to assign"
},
"primary": {
"type": [
"boolean",
"null"
],
"description": "A boolean indicating whether this should become the target's primary phone number."
},
"target_id": {
"type": "integer",
"description": "The ID of the target to reassign this number to."
},
"target_type": {
"type": "string",
"description": "The type of the target.",
"enum": [
"callcenter",
"callrouter",
"channel",
"coachinggroup",
"coachingteam",
"department",
"office",
"room",
"staffgroup",
"unknown",
"user"
]
}
},
"required": [
"PCID",
"number",
"target_id",
"target_type"
]
}
```
***
## dialpad\_admin\_numbers\_assign\_target\_number\_post
Dialpad Number -- Auto-Assign
**Parameters:**
| Parameter | Type | Required | Default | Description | |
| ------------- | ------- | -------- | ------- | ------------------------------------------------ | ---------------------------------------------------------------------------------- |
| `area_code` | string | null | No | — | An area code in which to find an available phone number for assignment. |
| `number` | string | null | No | — | A phone number to assign. (e164-formatted) |
| `primary` | boolean | null | No | — | A boolean indicating whether this should become the target's primary phone number. |
| `target_id` | integer | Yes | — | The ID of the target to reassign this number to. | |
| `target_type` | string | Yes | — | The type of the target. | |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"area_code": {
"type": [
"string",
"null"
],
"description": "An area code in which to find an available phone number for assignment."
},
"number": {
"type": [
"string",
"null"
],
"description": "A phone number to assign. (e164-formatted)"
},
"primary": {
"type": [
"boolean",
"null"
],
"description": "A boolean indicating whether this should become the target's primary phone number."
},
"target_id": {
"type": "integer",
"description": "The ID of the target to reassign this number to."
},
"target_type": {
"type": "string",
"description": "The type of the target.",
"enum": [
"callcenter",
"callrouter",
"channel",
"coachinggroup",
"coachingteam",
"department",
"office",
"room",
"staffgroup",
"unknown",
"user"
]
}
},
"required": [
"PCID",
"target_id",
"target_type"
]
}
```
***
## dialpad\_admin\_numbers\_delete
Dialpad Number -- Unassign
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------- | -------- | ------- | ---------------------------------------------------------------------- |
| `number` | string | Yes | — | A phone number (e164 format). |
| `release` | boolean | No | — | Releases the number (does not return it to the company reserved pool). |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"number": {
"type": "string",
"description": "A phone number (e164 format)."
},
"release": {
"type": "boolean",
"description": "Releases the number (does not return it to the company reserved pool)."
}
},
"required": [
"PCID",
"number"
]
}
```
***
## dialpad\_admin\_numbers\_get
Dialpad Number -- Get
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------ | -------- | ------- | ----------------------------- |
| `number` | string | Yes | — | A phone number (e164 format). |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"number": {
"type": "string",
"description": "A phone number (e164 format)."
}
},
"required": [
"PCID",
"number"
]
}
```
***
## dialpad\_admin\_numbers\_list
Dialpad Number -- List
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------------- |
| `cursor` | string | No | — | A token used to return the next page of a previous request. Use the cursor provided in the previous response. |
| `status` | string | No | — | Status to filter by. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"cursor": {
"type": "string",
"description": "A token used to return the next page of a previous request. Use the cursor provided in the previous response."
},
"status": {
"type": "string",
"description": "Status to filter by."
}
},
"required": [
"PCID"
]
}
```
***
## dialpad\_admin\_numbers\_swap\_number\_post
Dialpad Number -- Swap
**Parameters:**
| Parameter | Type | Required | Default | Description |
| -------------- | ------ | -------- | ------- | --------------------------------------------------------- |
| `swap_details` | object | No | — | Type of number swap (area\_code, auto, provided\_number). |
| `target` | object | Yes | — | The target value |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"swap_details": {
"description": "Type of number swap (area_code, auto, provided_number)."
},
"target": {
"type": "object",
"description": "The target value",
"properties": {
"target_id": {
"type": "integer",
"description": "The ID of the target to swap number."
},
"target_type": {
"type": "string",
"description": "The type of the target.",
"enum": [
"callcenter",
"callrouter",
"channel",
"coachinggroup",
"coachingteam",
"department",
"office",
"room",
"staffgroup",
"unknown",
"user"
]
}
},
"required": [
"target_id",
"target_type"
]
}
},
"required": [
"PCID",
"target"
]
}
```
***
## dialpad\_admin\_schedule\_reports\_create
schedule reports -- Create
**Parameters:**
| Parameter | Type | Required | Default | Description | |
| ---------------- | ------- | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- |
| `at` | integer | Yes | — | Hour of the day when the report will execute considering the frequency and timezones between 0 and 23 e.g. 10 will be 10:00 am. | |
| `coaching_group` | boolean | null | No | — | Whether the statistics should be for trainees of the coach group with the given target\_id. |
| `enabled` | boolean | null | No | — | Whether or not this schedule reports event subscription is enabled. |
| `endpoint_id` | integer | Yes | — | The logging endpoint's ID, which is generated after creating a webhook or websocket successfully. | |
| `frequency` | string | Yes | — | How often the report will execute. | |
| `name` | string | Yes | — | \[single-line only] The name of the schedule reports. | |
| `on_day` | integer | Yes | — | The day of the week or month when the report will execute considering the frequency. daily=0, weekly=0-6, monthly=0-30. | |
| `report_type` | string | Yes | — | The type of report that will be generated. | |
| `target_id` | integer | null | No | — | The target's id. |
| `target_type` | string | null | No | — | Target's type. |
| `timezone` | string | null | No | — | Timezone using a tz database name. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"at": {
"type": "integer",
"description": "Hour of the day when the report will execute considering the frequency and timezones between 0 and 23 e.g. 10 will be 10:00 am."
},
"coaching_group": {
"type": [
"boolean",
"null"
],
"description": "Whether the statistics should be for trainees of the coach group with the given target_id."
},
"enabled": {
"type": [
"boolean",
"null"
],
"description": "Whether or not this schedule reports event subscription is enabled."
},
"endpoint_id": {
"type": "integer",
"description": "The logging endpoint's ID, which is generated after creating a webhook or websocket successfully."
},
"frequency": {
"type": "string",
"description": "How often the report will execute.",
"enum": [
"daily",
"monthly",
"weekly"
]
},
"name": {
"type": "string",
"description": "[single-line only] The name of the schedule reports."
},
"on_day": {
"type": "integer",
"description": "The day of the week or month when the report will execute considering the frequency. daily=0, weekly=0-6, monthly=0-30."
},
"report_type": {
"type": "string",
"description": "The type of report that will be generated.",
"enum": [
"call_logs",
"daily_statistics",
"recordings",
"user_statistics",
"voicemails"
]
},
"target_id": {
"type": [
"integer",
"null"
],
"description": "The target's id."
},
"target_type": {
"type": [
"string",
"null"
],
"description": "Target's type.",
"enum": [
"callcenter",
"callrouter",
"channel",
"coachinggroup",
"coachingteam",
"department",
"office",
"room",
"staffgroup",
"unknown",
"user"
]
},
"timezone": {
"type": [
"string",
"null"
],
"description": "Timezone using a tz database name."
}
},
"required": [
"PCID",
"at",
"endpoint_id",
"frequency",
"name",
"on_day",
"report_type"
]
}
```
***
## dialpad\_admin\_schedule\_reports\_delete
Schedule reports -- Delete
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------- | -------- | ------- | --------------------------------------- |
| `id` | integer | Yes | — | The schedule reports subscription's ID. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "The schedule reports subscription's ID."
}
},
"required": [
"PCID",
"id"
]
}
```
***
## dialpad\_admin\_schedule\_reports\_get
Schedule reports -- Get
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------- | -------- | ------- | --------------------------------------- |
| `id` | integer | Yes | — | The schedule reports subscription's ID. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "The schedule reports subscription's ID."
}
},
"required": [
"PCID",
"id"
]
}
```
***
## dialpad\_admin\_schedule\_reports\_list
Schedule reports -- List
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------------- |
| `cursor` | string | No | — | A token used to return the next page of a previous request. Use the cursor provided in the previous response. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"cursor": {
"type": "string",
"description": "A token used to return the next page of a previous request. Use the cursor provided in the previous response."
}
},
"required": [
"PCID"
]
}
```
***
## dialpad\_admin\_schedule\_reports\_update
Schedule reports -- Update
**Parameters:**
| Parameter | Type | Required | Default | Description | |
| ---------------- | ------- | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- |
| `id` | integer | Yes | — | The schedule reports subscription's ID. | |
| `at` | integer | Yes | — | Hour of the day when the report will execute considering the frequency and timezones between 0 and 23 e.g. 10 will be 10:00 am. | |
| `coaching_group` | boolean | null | No | — | Whether the statistics should be for trainees of the coach group with the given target\_id. |
| `enabled` | boolean | null | No | — | Whether or not this schedule reports event subscription is enabled. |
| `endpoint_id` | integer | Yes | — | The logging endpoint's ID, which is generated after creating a webhook or websocket successfully. | |
| `frequency` | string | Yes | — | How often the report will execute. | |
| `name` | string | Yes | — | \[single-line only] The name of the schedule reports. | |
| `on_day` | integer | Yes | — | The day of the week or month when the report will execute considering the frequency. daily=0, weekly=0-6, monthly=0-30. | |
| `report_type` | string | Yes | — | The type of report that will be generated. | |
| `target_id` | integer | null | No | — | The target's id. |
| `target_type` | string | null | No | — | Target's type. |
| `timezone` | string | null | No | — | Timezone using a tz database name. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "The schedule reports subscription's ID."
},
"at": {
"type": "integer",
"description": "Hour of the day when the report will execute considering the frequency and timezones between 0 and 23 e.g. 10 will be 10:00 am."
},
"coaching_group": {
"type": [
"boolean",
"null"
],
"description": "Whether the statistics should be for trainees of the coach group with the given target_id."
},
"enabled": {
"type": [
"boolean",
"null"
],
"description": "Whether or not this schedule reports event subscription is enabled."
},
"endpoint_id": {
"type": "integer",
"description": "The logging endpoint's ID, which is generated after creating a webhook or websocket successfully."
},
"frequency": {
"type": "string",
"description": "How often the report will execute.",
"enum": [
"daily",
"monthly",
"weekly"
]
},
"name": {
"type": "string",
"description": "[single-line only] The name of the schedule reports."
},
"on_day": {
"type": "integer",
"description": "The day of the week or month when the report will execute considering the frequency. daily=0, weekly=0-6, monthly=0-30."
},
"report_type": {
"type": "string",
"description": "The type of report that will be generated.",
"enum": [
"call_logs",
"daily_statistics",
"recordings",
"user_statistics",
"voicemails"
]
},
"target_id": {
"type": [
"integer",
"null"
],
"description": "The target's id."
},
"target_type": {
"type": [
"string",
"null"
],
"description": "Target's type.",
"enum": [
"callcenter",
"callrouter",
"channel",
"coachinggroup",
"coachingteam",
"department",
"office",
"room",
"staffgroup",
"unknown",
"user"
]
},
"timezone": {
"type": [
"string",
"null"
],
"description": "Timezone using a tz database name."
}
},
"required": [
"PCID",
"id",
"at",
"endpoint_id",
"frequency",
"name",
"on_day",
"report_type"
]
}
```
***
## dialpad\_admin\_stats\_create
Stats -- Initiate Processing
**Parameters:**
| Parameter | Type | Required | Default | Description | |
| ---------------- | ------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `coaching_group` | boolean | null | No | — | Whether or not the statistics should be for trainees of the coach group with the given target\_id. |
| `coaching_team` | boolean | null | No | — | Whether or not the statistics should be for trainees of the coach team with the given target\_id. |
| `days_ago_end` | integer | null | No | — | End of the date range to get statistics for. This is the number of days to look back relative to the current day. Used in conjunction with days\_ago\_start to specify a range. |
| `days_ago_start` | integer | null | No | — | Start of the date range to get statistics for. This is the number of days to look back relative to the current day. Used in conjunction with days\_ago\_end to specify a range. |
| `export_type` | string | Yes | — | Whether to return aggregated statistics (stats), or individual rows for each record (records). NOTE: For stat\_type "csat" or "dispositions", only "records" is supported. | |
| `group_by` | string | null | No | — | This param is only applicable when the stat\_type is specified as call. For call stats, group calls by user per day (default), get total metrics by day, or break down by department and call center (office only). |
| `is_today` | boolean | null | No | — | Whether or not the statistics are for the current day. NOTE: days\_ago\_start and days\_ago\_end are ignored if this is passed in. |
| `office_id` | integer | null | No | — | ID of the office to get statistics for. If a target\_id and target\_type are passed in this value is ignored and instead the target is used. |
| `stat_type` | string | Yes | — | The type of statistics to be returned. NOTE: if the value is "csat" or "dispositions", target\_id and target\_type must be specified. | |
| `target_id` | integer | null | No | — | The target's id. |
| `target_type` | string | null | No | — | Target's type. |
| `timezone` | string | null | No | — | Timezone using a tz database name. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"coaching_group": {
"type": [
"boolean",
"null"
],
"description": "Whether or not the statistics should be for trainees of the coach group with the given target_id."
},
"coaching_team": {
"type": [
"boolean",
"null"
],
"description": "Whether or not the statistics should be for trainees of the coach team with the given target_id."
},
"days_ago_end": {
"type": [
"integer",
"null"
],
"description": "End of the date range to get statistics for. This is the number of days to look back relative to the current day. Used in conjunction with days_ago_start to specify a range."
},
"days_ago_start": {
"type": [
"integer",
"null"
],
"description": "Start of the date range to get statistics for. This is the number of days to look back relative to the current day. Used in conjunction with days_ago_end to specify a range."
},
"export_type": {
"type": "string",
"description": "Whether to return aggregated statistics (stats), or individual rows for each record (records). NOTE: For stat_type \"csat\" or \"dispositions\", only \"records\" is supported.",
"enum": [
"records",
"stats"
]
},
"group_by": {
"type": [
"string",
"null"
],
"description": "This param is only applicable when the stat_type is specified as call. For call stats, group calls by user per day (default), get total metrics by day, or break down by department and call center (office only).",
"enum": [
"date",
"group",
"user"
]
},
"is_today": {
"type": [
"boolean",
"null"
],
"description": "Whether or not the statistics are for the current day. NOTE: days_ago_start and days_ago_end are ignored if this is passed in."
},
"office_id": {
"type": [
"integer",
"null"
],
"description": "ID of the office to get statistics for. If a target_id and target_type are passed in this value is ignored and instead the target is used."
},
"stat_type": {
"type": "string",
"description": "The type of statistics to be returned. NOTE: if the value is \"csat\" or \"dispositions\", target_id and target_type must be specified.",
"enum": [
"calls",
"csat",
"dispositions",
"onduty",
"recordings",
"screenshare",
"texts",
"voicemails"
]
},
"target_id": {
"type": [
"integer",
"null"
],
"description": "The target's id."
},
"target_type": {
"type": [
"string",
"null"
],
"description": "Target's type.",
"enum": [
"callcenter",
"coachinggroup",
"coachingteam",
"department",
"office",
"room",
"staffgroup",
"unknown",
"user"
]
},
"timezone": {
"type": [
"string",
"null"
],
"description": "Timezone using a tz database name."
}
},
"required": [
"PCID",
"export_type",
"stat_type"
]
}
```
***
## dialpad\_admin\_stats\_get
Stats -- Get Result
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------ | -------- | ------- | --------------------------------------------- |
| `id` | string | Yes | — | Request ID returned by a POST /stats request. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "Request ID returned by a POST /stats request."
}
},
"required": [
"PCID",
"id"
]
}
```
***
## dialpad\_admin\_tags\_patch
Number Tags -- Update tags for a phone number.
**Parameters:**
| Parameter | Type | Required | Default | Description | |
| ------------- | ------- | -------- | ------- | -------------------------------------------------------- | ------------------------------------------------ |
| `do_not_call` | boolean | null | No | — | Whether calls should be blocked for this number. |
| `do_not_text` | boolean | null | No | — | Whether texts should be blocked for this number. |
| `phone` | string | Yes | — | The phone number in E.164 format (e.g., "+14155551234"). | |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"do_not_call": {
"type": [
"boolean",
"null"
],
"description": "Whether calls should be blocked for this number."
},
"do_not_text": {
"type": [
"boolean",
"null"
],
"description": "Whether texts should be blocked for this number."
},
"phone": {
"type": "string",
"description": "The phone number in E.164 format (e.g., \"+14155551234\")."
}
},
"required": [
"PCID",
"phone"
]
}
```
***
## dialpad\_admin\_webhook\_update
Webhook -- Update
**Parameters:**
| Parameter | Type | Required | Default | Description | |
| ---------- | ------- | -------- | ------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- |
| `id` | integer | Yes | — | The webhook's ID, which is generated after creating a webhook successfully. | |
| `hook_url` | string | null | No | — | The webhook's URL. Triggered events will be sent to the url provided here. |
| `secret` | string | null | No | — | \[single-line only] Webhook's signature secret that's used to confirm the validity of the request. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "The webhook's ID, which is generated after creating a webhook successfully."
},
"hook_url": {
"type": [
"string",
"null"
],
"description": "The webhook's URL. Triggered events will be sent to the url provided here."
},
"secret": {
"type": [
"string",
"null"
],
"description": "[single-line only] Webhook's signature secret that's used to confirm the validity of the request."
}
},
"required": [
"PCID",
"id"
]
}
```
***
## dialpad\_admin\_webhooks\_create
Webhook -- Create
**Parameters:**
| Parameter | Type | Required | Default | Description | |
| ---------- | ------ | -------- | ------- | -------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- |
| `hook_url` | string | Yes | — | The webhook's URL. Triggered events will be sent to the url provided here. | |
| `secret` | string | null | No | — | \[single-line only] Webhook's signature secret that's used to confirm the validity of the request. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"hook_url": {
"type": "string",
"description": "The webhook's URL. Triggered events will be sent to the url provided here."
},
"secret": {
"type": [
"string",
"null"
],
"description": "[single-line only] Webhook's signature secret that's used to confirm the validity of the request."
}
},
"required": [
"PCID",
"hook_url"
]
}
```
***
## dialpad\_admin\_webhooks\_delete
Webhook -- Delete
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------- | -------- | ------- | --------------------------------------------------------------------------- |
| `id` | integer | Yes | — | The webhook's ID, which is generated after creating a webhook successfully. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "The webhook's ID, which is generated after creating a webhook successfully."
}
},
"required": [
"PCID",
"id"
]
}
```
***
## dialpad\_admin\_webhooks\_get
Webhook -- Get
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------- | -------- | ------- | --------------------------------------------------------------------------- |
| `id` | integer | Yes | — | The webhook's ID, which is generated after creating a webhook successfully. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "The webhook's ID, which is generated after creating a webhook successfully."
}
},
"required": [
"PCID",
"id"
]
}
```
***
## dialpad\_admin\_webhooks\_list
Webhook -- List
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------------- |
| `cursor` | string | No | — | A token used to return the next page of a previous request. Use the cursor provided in the previous response. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"cursor": {
"type": "string",
"description": "A token used to return the next page of a previous request. Use the cursor provided in the previous response."
}
},
"required": [
"PCID"
]
}
```
***
## dialpad\_admin\_websockets\_create
Websocket -- Create
**Parameters:**
| Parameter | Type | Required | Default | Description | |
| --------- | ------ | -------- | ------- | ----------- | ----------------------------------------------------------------------------------------------------- |
| `secret` | string | null | No | — | \[single-line only] Websocket's signature secret that's used to confirm the validity of the request. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"secret": {
"type": [
"string",
"null"
],
"description": "[single-line only] Websocket's signature secret that's used to confirm the validity of the request."
}
},
"required": [
"PCID"
]
}
```
***
## dialpad\_admin\_websockets\_delete
Websocket -- Delete
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------- | -------- | ------- | ------------------------------------------------------------------------------- |
| `id` | integer | Yes | — | The websocket's ID, which is generated after creating a websocket successfully. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "The websocket's ID, which is generated after creating a websocket successfully."
}
},
"required": [
"PCID",
"id"
]
}
```
***
## dialpad\_admin\_websockets\_get
Websocket -- Get
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------- | -------- | ------- | ------------------------------------------------------------------------------- |
| `id` | integer | Yes | — | The websocket's ID, which is generated after creating a websocket successfully. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "The websocket's ID, which is generated after creating a websocket successfully."
}
},
"required": [
"PCID",
"id"
]
}
```
***
## dialpad\_admin\_websockets\_list
Websocket -- List
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------------- |
| `cursor` | string | No | — | A token used to return the next page of a previous request. Use the cursor provided in the previous response. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"cursor": {
"type": "string",
"description": "A token used to return the next page of a previous request. Use the cursor provided in the previous response."
}
},
"required": [
"PCID"
]
}
```
***
## dialpad\_admin\_websockets\_update
Websocket -- Update
**Parameters:**
| Parameter | Type | Required | Default | Description | |
| --------- | ------- | -------- | ------- | ------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- |
| `id` | integer | Yes | — | The websocket's ID, which is generated after creating a websocket successfully. | |
| `secret` | string | null | No | — | \[single-line only] Websocket's signature secret that's used to confirm the validity of the request. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "The websocket's ID, which is generated after creating a websocket successfully."
},
"secret": {
"type": [
"string",
"null"
],
"description": "[single-line only] Websocket's signature secret that's used to confirm the validity of the request."
}
},
"required": [
"PCID",
"id"
]
}
```