> ## 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-organization > Organization Management **Server path:** `/dialpad-organization` | **Type:** Application | **PCID required:** Yes ## Tools | Tool | Description | | ----------------------------------------------------------------------------------------------------------------------------------- | ------------------------------- | | [`dialpad_organization_callcenters_list`](#dialpad_organization_callcenters_list) | Call Centers -- List | | [`dialpad_organization_coaching_team_list`](#dialpad_organization_coaching_team_list) | Coaching Team -- List | | [`dialpad_organization_company_get`](#dialpad_organization_company_get) | Company -- Get | | [`dialpad_organization_company_sms_opt_out`](#dialpad_organization_company_sms_opt_out) | Company -- Get SMS Opt-out List | | [`dialpad_organization_company_update_settings`](#dialpad_organization_company_update_settings) | Company -- Update Settings | | [`dialpad_organization_departments_create`](#dialpad_organization_departments_create) | Departments -- Create | | [`dialpad_organization_departments_delete`](#dialpad_organization_departments_delete) | Departments -- Delete | | [`dialpad_organization_departments_get`](#dialpad_organization_departments_get) | Department -- Get | | [`dialpad_organization_departments_list`](#dialpad_organization_departments_list) | Department -- List | | [`dialpad_organization_departments_listall`](#dialpad_organization_departments_listall) | Department -- List | | [`dialpad_organization_departments_operators_delete`](#dialpad_organization_departments_operators_delete) | Operator -- Remove | | [`dialpad_organization_departments_operators_get`](#dialpad_organization_departments_operators_get) | Operator -- List | | [`dialpad_organization_departments_operators_post`](#dialpad_organization_departments_operators_post) | Operator -- Add | | [`dialpad_organization_departments_update`](#dialpad_organization_departments_update) | Departments -- Update | | [`dialpad_organization_deskphones_rooms_create_international_pin`](#dialpad_organization_deskphones_rooms_create_international_pin) | Room Phone -- Assign PIN | | [`dialpad_organization_deskphones_rooms_delete`](#dialpad_organization_deskphones_rooms_delete) | Room Phone -- Delete | | [`dialpad_organization_deskphones_rooms_get`](#dialpad_organization_deskphones_rooms_get) | Room Phone -- Get | | [`dialpad_organization_deskphones_rooms_list`](#dialpad_organization_deskphones_rooms_list) | Room Phone -- List | | [`dialpad_organization_numbers_assign_office_number_post`](#dialpad_organization_numbers_assign_office_number_post) | Dialpad Number -- Assign | | [`dialpad_organization_numbers_assign_room_number_post`](#dialpad_organization_numbers_assign_room_number_post) | Dialpad Number -- Assign | | [`dialpad_organization_numbers_office_unassign_number_post`](#dialpad_organization_numbers_office_unassign_number_post) | Dialpad Number -- Unassign | | [`dialpad_organization_numbers_room_unassign_number_post`](#dialpad_organization_numbers_room_unassign_number_post) | Dialpad Number -- Unassign | | [`dialpad_organization_offices_create`](#dialpad_organization_offices_create) | Office -- Create | | [`dialpad_organization_offices_e911_get`](#dialpad_organization_offices_e911_get) | E911 Address -- Get | | [`dialpad_organization_offices_e911_update`](#dialpad_organization_offices_e911_update) | E911 Address -- Update | | [`dialpad_organization_offices_get`](#dialpad_organization_offices_get) | Office -- Get | | [`dialpad_organization_offices_list`](#dialpad_organization_offices_list) | Office -- List | | [`dialpad_organization_offices_offdutystatuses_get`](#dialpad_organization_offices_offdutystatuses_get) | Off-Duty Status -- List | | [`dialpad_organization_offices_operators_delete`](#dialpad_organization_offices_operators_delete) | Operator -- Remove | | [`dialpad_organization_offices_operators_get`](#dialpad_organization_offices_operators_get) | Operator -- List | | [`dialpad_organization_offices_operators_post`](#dialpad_organization_offices_operators_post) | Operator -- Add | | [`dialpad_organization_offices_primary_get`](#dialpad_organization_offices_primary_get) | Office -- Get Primary | | [`dialpad_organization_offices_update`](#dialpad_organization_offices_update) | Office -- Update | | [`dialpad_organization_plan_available_licenses_get`](#dialpad_organization_plan_available_licenses_get) | Licenses -- List Available | | [`dialpad_organization_plan_get`](#dialpad_organization_plan_get) | Billing Plan -- Get | | [`dialpad_organization_rooms_delete`](#dialpad_organization_rooms_delete) | Room -- Delete | | [`dialpad_organization_rooms_get`](#dialpad_organization_rooms_get) | Room -- Get | | [`dialpad_organization_rooms_list`](#dialpad_organization_rooms_list) | Room -- List | | [`dialpad_organization_rooms_patch`](#dialpad_organization_rooms_patch) | Room -- Update | | [`dialpad_organization_rooms_post`](#dialpad_organization_rooms_post) | Room -- Create | *** ## dialpad\_organization\_callcenters\_list Call Centers -- 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. | | `office_id` | integer | Yes | — | The office'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." }, "office_id": { "type": "integer", "description": "The office's id." } }, "required": [ "PCID", "office_id" ] } ``` *** ## dialpad\_organization\_coaching\_team\_list Coaching Team -- 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. | | `office_id` | integer | Yes | — | The office'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." }, "office_id": { "type": "integer", "description": "The office's id." } }, "required": [ "PCID", "office_id" ] } ``` *** ## dialpad\_organization\_company\_get Company -- Get ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" } }, "required": [ "PCID" ] } ``` *** ## dialpad\_organization\_company\_sms\_opt\_out Company -- Get SMS Opt-out List **Parameters:** | Parameter | Type | Required | Default | Description | | ----------------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `id` | string | Yes | — | ID of the requested company. This is required and must be specified in the URL path. The value must match the id from the company linked to the API key. | | `a2p_campaign_id` | integer | No | — | Optional company A2P campaign entity id to filter results by. Note, if set, then the parameter 'opt\_out\_state' must be also set to the value 'opted\_out'. | | `cursor` | string | No | — | Optional token used to return the next page of a previous request. Use the cursor provided in the previous response. | | `opt_out_state` | string | Yes | — | Required opt-out state to filter results by. Only results matching this state will be returned. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "string", "description": "ID of the requested company. This is required and must be specified in the URL path. The value must match the id from the company linked to the API key." }, "a2p_campaign_id": { "type": "integer", "description": "Optional company A2P campaign entity id to filter results by. Note, if set, then the parameter 'opt_out_state' must be also set to the value 'opted_out'." }, "cursor": { "type": "string", "description": "Optional token used to return the next page of a previous request. Use the cursor provided in the previous response." }, "opt_out_state": { "type": "string", "description": "Required opt-out state to filter results by. Only results matching this state will be returned.", "enum": [ "opted_back_in", "opted_out" ] } }, "required": [ "PCID", "id", "opt_out_state" ] } ``` *** ## dialpad\_organization\_company\_update\_settings Company -- Update Settings **Parameters:** | Parameter | Type | Required | Default | Description | | ------------ | ------- | -------- | ------- | --------------------------------------------- | | `has_callai` | boolean | No | — | If Call AI setting should be enabled/disabled | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "has_callai": { "type": "boolean", "description": "If Call AI setting should be enabled/disabled" } }, "required": [ "PCID" ] } ``` *** ## dialpad\_organization\_departments\_create Departments -- Create **Parameters:** | Parameter | Type | Required | Default | Description | | | --------------------- | --------- | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `auto_call_recording` | boolean | null | No | — | Whether or not automatically record all calls of this department. Default is False. | | `friday_hours` | string\[] | No | — | The Friday hours of operation. Default value is \["08:00", "18:00"]. | | | `group_description` | string | null | No | — | The description of the department. Max 256 characters. | | `hold_queue` | object | No | — | Hold Queue | | | `hours_on` | boolean | null | No | — | The time frame when the department wants to receive calls. Default value is false, which means the call center will always take calls (24/7). | | `monday_hours` | string\[] | No | — | The Monday hours of operation. To specify when hours\_on is set to True. e.g. \["08:00", "12:00", "14:00", "18:00"] => open from 8AM to Noon, and from 2PM to 6PM. Default value is \["08:00", "18:00"]. | | | `name` | string | Yes | — | \[single-line only] The name of the department. Max 100 characters. | | | `office_id` | integer | Yes | — | The id of the office to which the department belongs.. | | | `ring_seconds` | integer | null | No | — | The number of seconds to allow the group line to ring before going to voicemail. Choose from 10 seconds to 45 seconds. Default is 30 seconds. | | `routing_options` | object | No | — | Routing Options | | | `saturday_hours` | string\[] | No | — | The Saturday hours of operation. Default is empty array. | | | `sunday_hours` | string\[] | No | — | The Sunday hours of operation. Default is empty array. | | | `thursday_hours` | string\[] | No | — | The Thursday hours of operation. Default value is \["08:00", "18:00"]. | | | `tuesday_hours` | string\[] | No | — | The Tuesday hours of operation. Default value is \["08:00", "18:00"]. | | | `voice_intelligence` | object | No | — | Voice Intelligence | | | `wednesday_hours` | string\[] | No | — | The Wednesday hours of operation. Default value is \["08:00", "18:00"]. | | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "auto_call_recording": { "type": [ "boolean", "null" ], "description": "Whether or not automatically record all calls of this department. Default is False." }, "friday_hours": { "type": "array", "items": { "type": "string" }, "description": "The Friday hours of operation. Default value is [\"08:00\", \"18:00\"]." }, "group_description": { "type": [ "string", "null" ], "description": "The description of the department. Max 256 characters." }, "hold_queue": { "type": "object", "description": "Hold Queue", "properties": { "allow_queuing": { "type": "boolean", "description": "Whether or not send callers to a hold queue, if all operators are busy on other calls. Default is False." }, "max_hold_count": { "type": "integer", "description": "If all operators are busy on other calls, send callers to a hold queue. This is to specify your queue size. Choose from 1-50. Default is 50." }, "max_hold_seconds": { "type": "integer", "description": "Maximum queue wait time in seconds. Choose from 30s to 18000s (3 hours). Default is 900s (15 min)." } } }, "hours_on": { "type": [ "boolean", "null" ], "description": "The time frame when the department wants to receive calls. Default value is false, which means the call center will always take calls (24/7)." }, "monday_hours": { "type": "array", "items": { "type": "string" }, "description": "The Monday hours of operation. To specify when hours_on is set to True. e.g. [\"08:00\", \"12:00\", \"14:00\", \"18:00\"] => open from 8AM to Noon, and from 2PM to 6PM. Default value is [\"08:00\", \"18:00\"]." }, "name": { "type": "string", "description": "[single-line only] The name of the department. Max 100 characters." }, "office_id": { "type": "integer", "description": "The id of the office to which the department belongs.." }, "ring_seconds": { "type": [ "integer", "null" ], "description": "The number of seconds to allow the group line to ring before going to voicemail. Choose from 10 seconds to 45 seconds. Default is 30 seconds." }, "routing_options": { "type": "object", "description": "Routing Options", "properties": { "closed": { "type": "object", "description": "The closed value" }, "open": { "type": "object", "description": "The open value" } }, "required": [ "closed", "open" ] }, "saturday_hours": { "type": "array", "items": { "type": "string" }, "description": "The Saturday hours of operation. Default is empty array." }, "sunday_hours": { "type": "array", "items": { "type": "string" }, "description": "The Sunday hours of operation. Default is empty array." }, "thursday_hours": { "type": "array", "items": { "type": "string" }, "description": "The Thursday hours of operation. Default value is [\"08:00\", \"18:00\"]." }, "tuesday_hours": { "type": "array", "items": { "type": "string" }, "description": "The Tuesday hours of operation. Default value is [\"08:00\", \"18:00\"]." }, "voice_intelligence": { "type": "object", "description": "Voice Intelligence", "properties": { "allow_pause": { "type": "boolean", "description": "Allow individual users to start and stop Vi during calls. Default is True." }, "auto_start": { "type": "boolean", "description": "Auto start Vi for this call center. Default is True." } } }, "wednesday_hours": { "type": "array", "items": { "type": "string" }, "description": "The Wednesday hours of operation. Default value is [\"08:00\", \"18:00\"]." } }, "required": [ "PCID", "name", "office_id" ] } ``` *** ## dialpad\_organization\_departments\_delete Departments -- Delete **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------- | -------- | ------- | -------------------- | | `id` | integer | Yes | — | The department's id. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "integer", "description": "The department's id." } }, "required": [ "PCID", "id" ] } ``` *** ## dialpad\_organization\_departments\_get Department -- Get **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------- | -------- | ------- | -------------------- | | `id` | integer | Yes | — | The department's id. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "integer", "description": "The department's id." } }, "required": [ "PCID", "id" ] } ``` *** ## dialpad\_organization\_departments\_list Department -- 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. | | `office_id` | integer | Yes | — | The office'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." }, "office_id": { "type": "integer", "description": "The office's id." } }, "required": [ "PCID", "office_id" ] } ``` *** ## dialpad\_organization\_departments\_listall Department -- 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. | | `office_id` | integer | No | — | filter departments by office. | | `name_search` | string | No | — | search departments by name or search by the substring of the name. If input example is 'Happy', output example can be a list of departments whose name contains the string Happy - \['Happy department 1', 'Happy department 2'] | ```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." }, "office_id": { "type": "integer", "description": "filter departments by office." }, "name_search": { "type": "string", "description": "search departments by name or search by the substring of the name. If input example is 'Happy', output example can be a list of departments whose name contains the string Happy - ['Happy department 1', 'Happy department 2']" } }, "required": [ "PCID" ] } ``` *** ## dialpad\_organization\_departments\_operators\_delete Operator -- Remove **Parameters:** | Parameter | Type | Required | Default | Description | | --------------- | ------- | -------- | ------- | -------------------------------------------------- | | `id` | integer | Yes | — | The department's id. | | `operator_id` | integer | Yes | — | ID of the operator to remove. | | `operator_type` | string | Yes | — | Type of the operator to remove (`user` or `room`). | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "integer", "description": "The department's id." }, "operator_id": { "type": "integer", "description": "ID of the operator to remove." }, "operator_type": { "type": "string", "description": "Type of the operator to remove (`user` or `room`).", "enum": [ "room", "user" ] } }, "required": [ "PCID", "id", "operator_id", "operator_type" ] } ``` *** ## dialpad\_organization\_departments\_operators\_get Operator -- List **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------- | -------- | ------- | -------------------- | | `id` | integer | Yes | — | The department's id. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "integer", "description": "The department's id." } }, "required": [ "PCID", "id" ] } ``` *** ## dialpad\_organization\_departments\_operators\_post Operator -- Add **Parameters:** | Parameter | Type | Required | Default | Description | | | --------------- | ------- | -------- | ------- | ----------------------------------------------- | ----------------------------------------------------- | | `id` | integer | Yes | — | The department's id. | | | `operator_id` | integer | Yes | — | ID of the operator to add. | | | `operator_type` | string | Yes | — | Type of the operator to add. (`user` or `room`) | | | `role` | string | null | No | — | The role of the new operator. (`operator` or `admin`) | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "integer", "description": "The department's id." }, "operator_id": { "type": "integer", "description": "ID of the operator to add." }, "operator_type": { "type": "string", "description": "Type of the operator to add. (`user` or `room`)", "enum": [ "room", "user" ] }, "role": { "type": [ "string", "null" ], "description": "The role of the new operator. (`operator` or `admin`)", "enum": [ "admin", "operator" ] } }, "required": [ "PCID", "id", "operator_id", "operator_type" ] } ``` *** ## dialpad\_organization\_departments\_update Departments -- Update **Parameters:** | Parameter | Type | Required | Default | Description | | | --------------------- | --------- | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | integer | Yes | — | The department's id. | | | `auto_call_recording` | boolean | null | No | — | Whether or not automatically record all calls of this department. Default is False. | | `friday_hours` | string\[] | No | — | The Friday hours of operation. Default value is \["08:00", "18:00"]. | | | `group_description` | string | null | No | — | The description of the department. Max 256 characters. | | `hold_queue` | object | No | — | Hold Queue | | | `hours_on` | boolean | null | No | — | The time frame when the department wants to receive calls. Default value is false, which means the call center will always take calls (24/7). | | `monday_hours` | string\[] | No | — | The Monday hours of operation. To specify when hours\_on is set to True. e.g. \["08:00", "12:00", "14:00", "18:00"] => open from 8AM to Noon, and from 2PM to 6PM. Default value is \["08:00", "18:00"]. | | | `name` | string | null | No | — | \[single-line only] The name of the department. Max 100 characters. | | `ring_seconds` | integer | null | No | — | The number of seconds to allow the group line to ring before going to voicemail. Choose from 10 seconds to 45 seconds. Default is 30 seconds. | | `routing_options` | object | No | — | Routing Options | | | `saturday_hours` | string\[] | No | — | The Saturday hours of operation. Default is empty array. | | | `sunday_hours` | string\[] | No | — | The Sunday hours of operation. Default is empty array. | | | `thursday_hours` | string\[] | No | — | The Thursday hours of operation. Default value is \["08:00", "18:00"]. | | | `tuesday_hours` | string\[] | No | — | The Tuesday hours of operation. Default value is \["08:00", "18:00"]. | | | `voice_intelligence` | object | No | — | Voice Intelligence | | | `wednesday_hours` | string\[] | No | — | The Wednesday hours of operation. Default value is \["08:00", "18:00"]. | | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "integer", "description": "The department's id." }, "auto_call_recording": { "type": [ "boolean", "null" ], "description": "Whether or not automatically record all calls of this department. Default is False." }, "friday_hours": { "type": "array", "items": { "type": "string" }, "description": "The Friday hours of operation. Default value is [\"08:00\", \"18:00\"]." }, "group_description": { "type": [ "string", "null" ], "description": "The description of the department. Max 256 characters." }, "hold_queue": { "type": "object", "description": "Hold Queue", "properties": { "allow_queuing": { "type": "boolean", "description": "Whether or not send callers to a hold queue, if all operators are busy on other calls. Default is False." }, "max_hold_count": { "type": "integer", "description": "If all operators are busy on other calls, send callers to a hold queue. This is to specify your queue size. Choose from 1-50. Default is 50." }, "max_hold_seconds": { "type": "integer", "description": "Maximum queue wait time in seconds. Choose from 30s to 18000s (3 hours). Default is 900s (15 min)." } } }, "hours_on": { "type": [ "boolean", "null" ], "description": "The time frame when the department wants to receive calls. Default value is false, which means the call center will always take calls (24/7)." }, "monday_hours": { "type": "array", "items": { "type": "string" }, "description": "The Monday hours of operation. To specify when hours_on is set to True. e.g. [\"08:00\", \"12:00\", \"14:00\", \"18:00\"] => open from 8AM to Noon, and from 2PM to 6PM. Default value is [\"08:00\", \"18:00\"]." }, "name": { "type": [ "string", "null" ], "description": "[single-line only] The name of the department. Max 100 characters." }, "ring_seconds": { "type": [ "integer", "null" ], "description": "The number of seconds to allow the group line to ring before going to voicemail. Choose from 10 seconds to 45 seconds. Default is 30 seconds." }, "routing_options": { "type": "object", "description": "Routing Options", "properties": { "closed": { "type": "object", "description": "The closed value" }, "open": { "type": "object", "description": "The open value" } }, "required": [ "closed", "open" ] }, "saturday_hours": { "type": "array", "items": { "type": "string" }, "description": "The Saturday hours of operation. Default is empty array." }, "sunday_hours": { "type": "array", "items": { "type": "string" }, "description": "The Sunday hours of operation. Default is empty array." }, "thursday_hours": { "type": "array", "items": { "type": "string" }, "description": "The Thursday hours of operation. Default value is [\"08:00\", \"18:00\"]." }, "tuesday_hours": { "type": "array", "items": { "type": "string" }, "description": "The Tuesday hours of operation. Default value is [\"08:00\", \"18:00\"]." }, "voice_intelligence": { "type": "object", "description": "Voice Intelligence", "properties": { "allow_pause": { "type": "boolean", "description": "Allow individual users to start and stop Vi during calls. Default is True." }, "auto_start": { "type": "boolean", "description": "Auto start Vi for this call center. Default is True." } } }, "wednesday_hours": { "type": "array", "items": { "type": "string" }, "description": "The Wednesday hours of operation. Default value is [\"08:00\", \"18:00\"]." } }, "required": [ "PCID", "id" ] } ``` *** ## dialpad\_organization\_deskphones\_rooms\_create\_international\_pin Room Phone -- Assign PIN **Parameters:** | Parameter | Type | Required | Default | Description | | | -------------- | ------ | -------- | ------- | ----------- | --------------------------------------------------------------------------------------------------------------------------------------- | | `customer_ref` | string | null | No | — | \[single-line only] An identifier to be printed in the usage summary. Typically used for identifying the person who requested the PIN. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "customer_ref": { "type": [ "string", "null" ], "description": "[single-line only] An identifier to be printed in the usage summary. Typically used for identifying the person who requested the PIN." } }, "required": [ "PCID" ] } ``` *** ## dialpad\_organization\_deskphones\_rooms\_delete Room Phone -- Delete **Parameters:** | Parameter | Type | Required | Default | Description | | ----------- | ------- | -------- | ------- | -------------------- | | `id` | string | Yes | — | The desk phone's id. | | `parent_id` | integer | Yes | — | The room's id. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "string", "description": "The desk phone's id." }, "parent_id": { "type": "integer", "description": "The room's id." } }, "required": [ "PCID", "id", "parent_id" ] } ``` *** ## dialpad\_organization\_deskphones\_rooms\_get Room Phone -- Get **Parameters:** | Parameter | Type | Required | Default | Description | | ----------- | ------- | -------- | ------- | -------------------- | | `id` | string | Yes | — | The desk phone's id. | | `parent_id` | integer | Yes | — | The room's id. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "string", "description": "The desk phone's id." }, "parent_id": { "type": "integer", "description": "The room's id." } }, "required": [ "PCID", "id", "parent_id" ] } ``` *** ## dialpad\_organization\_deskphones\_rooms\_list Room Phone -- List **Parameters:** | Parameter | Type | Required | Default | Description | | ----------- | ------- | -------- | ------- | -------------- | | `parent_id` | integer | Yes | — | The room's id. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "parent_id": { "type": "integer", "description": "The room's id." } }, "required": [ "PCID", "parent_id" ] } ``` *** ## dialpad\_organization\_numbers\_assign\_office\_number\_post Dialpad Number -- Assign **Parameters:** | Parameter | Type | Required | Default | Description | | | ----------- | ------- | -------- | ------- | ---------------- | ------------------------------------------------------------------------- | | `id` | integer | Yes | — | The office's id. | | | `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 primary phone number. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "integer", "description": "The office's id." }, "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 primary phone number." } }, "required": [ "PCID", "id" ] } ``` *** ## dialpad\_organization\_numbers\_assign\_room\_number\_post Dialpad Number -- Assign **Parameters:** | Parameter | Type | Required | Default | Description | | | ----------- | ------- | -------- | ------- | -------------- | ------------------------------------------------------------------------- | | `id` | integer | Yes | — | The room's id. | | | `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 primary phone number. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "integer", "description": "The room's id." }, "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 primary phone number." } }, "required": [ "PCID", "id" ] } ``` *** ## dialpad\_organization\_numbers\_office\_unassign\_number\_post Dialpad Number -- Unassign **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------- | -------- | ------- | -------------------------------------------- | | `id` | integer | Yes | — | The office's id. | | `number` | string | Yes | — | A phone number to unassign. (e164-formatted) | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "integer", "description": "The office's id." }, "number": { "type": "string", "description": "A phone number to unassign. (e164-formatted)" } }, "required": [ "PCID", "id", "number" ] } ``` *** ## dialpad\_organization\_numbers\_room\_unassign\_number\_post Dialpad Number -- Unassign **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------- | -------- | ------- | -------------------------------------------- | | `id` | integer | Yes | — | The room's id. | | `number` | string | Yes | — | A phone number to unassign. (e164-formatted) | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "integer", "description": "The room's id." }, "number": { "type": "string", "description": "A phone number to unassign. (e164-formatted)" } }, "required": [ "PCID", "id", "number" ] } ``` *** ## dialpad\_organization\_offices\_create Office -- Create **Parameters:** | Parameter | Type | Required | Default | Description | | | ------------------------------- | --------- | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------ | | `annual_commit_monthly_billing` | boolean | Yes | — | A flag indicating if the primary office's plan is categorized as annual commit monthly billing. | | | `auto_call_recording` | boolean | null | No | — | Whether or not automatically record all calls of this office. Default is False. | | `billing_address` | object | Yes | — | Billing Address | | | `billing_contact` | object | No | — | Billing Contact | | | `country` | string | Yes | — | The office country. | | | `currency` | string | Yes | — | The office's billing currency. | | | `e911_address` | object | No | — | E911 Address | | | `first_action` | string | null | No | — | The desired action when the office receives a call. | | `friday_hours` | string\[] | No | — | The Friday hours of operation. Default value is \["08:00", "18:00"]. | | | `group_description` | string | null | No | — | The description of the office. Max 256 characters. | | `hours_on` | boolean | null | No | — | The time frame when the office wants to receive calls. Default value is false, which means the office will always take calls (24/7). | | `international_enabled` | boolean | null | No | — | A flag indicating if the primary office is able to make international phone calls. | | `invoiced` | boolean | Yes | — | A flag indicating if the payment will be paid by invoice. | | | `mainline_number` | string | null | No | — | The mainline of the office. | | `monday_hours` | string\[] | No | — | The Monday hours of operation. To specify when hours\_on is set to True. e.g. \["08:00", "12:00", "14:00", "18:00"] => open from 8AM to Noon, and from 2PM to 6PM. Default value is \["08:00", "18:00"]. | | | `name` | string | Yes | — | \[single-line only] The office name. | | | `no_operators_action` | string | null | No | — | The action to take if there is no one available to answer calls. | | `plan_period` | string | Yes | — | The frequency at which the company will be billed. | | | `ring_seconds` | integer | null | No | — | The number of seconds to allow the group line to ring before going to voicemail. Choose from 10 seconds to 45 seconds. | | `routing_options` | object | No | — | Routing Options | | | `saturday_hours` | string\[] | No | — | The Saturday hours of operation. Default is empty array. | | | `sunday_hours` | string\[] | No | — | The Sunday hours of operation. Default is empty array. | | | `thursday_hours` | string\[] | No | — | The Thursday hours of operation. Default value is \["08:00", "18:00"]. | | | `timezone` | string | null | No | — | Timezone using a tz database name. | | `tuesday_hours` | string\[] | No | — | The Tuesday hours of operation. Default value is \["08:00", "18:00"]. | | | `unified_billing` | boolean | Yes | — | A flag indicating if to send a unified invoice. | | | `use_same_address` | boolean | null | No | — | A flag indicating if the billing address and the emergency address are the same. | | `voice_intelligence` | object | No | — | Voice Intelligence | | | `wednesday_hours` | string\[] | No | — | The Wednesday hours of operation. Default value is \["08:00", "18:00"]. | | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "annual_commit_monthly_billing": { "type": "boolean", "description": "A flag indicating if the primary office's plan is categorized as annual commit monthly billing." }, "auto_call_recording": { "type": [ "boolean", "null" ], "description": "Whether or not automatically record all calls of this office. Default is False." }, "billing_address": { "type": "object", "description": "Billing Address", "properties": { "address_line_1": { "type": "string", "description": "[single-line only] The first line of the billing address." }, "address_line_2": { "type": "string", "description": "[single-line only] The second line of the billing address." }, "city": { "type": "string", "description": "[single-line only] The billing address city." }, "country": { "type": "string", "description": "The billing address country." }, "postal_code": { "type": "string", "description": "[single-line only] The billing address postal code." }, "region": { "type": "string", "description": "[single-line only] The billing address region." } }, "required": [ "address_line_1", "city", "country", "postal_code", "region" ] }, "billing_contact": { "type": "object", "description": "Billing Contact", "properties": { "email": { "type": "string", "description": "The contact email." }, "name": { "type": "string", "description": "[single-line only] The contact name." }, "phone": { "type": "string", "description": "The contact phone number." } }, "required": [ "email", "name" ] }, "country": { "type": "string", "description": "The office country.", "enum": [ "AE", "AM", "AR", "AT", "AU", "BD", "BE", "BG", "BH", "BO", "BR", "CA", "CH", "CI", "CL", "CN", "CO", "CR", "CY", "CZ", "DE", "DK", "DO", "DP", "EC", "EE", "EG", "ES", "FI", "FR", "GB", "GH", "GR", "GT", "HK", "HR", "HU", "ID", "IE", "IL", "IN", "IS", "IT", "JP", "KE", "KH", "KR", "KZ", "LK", "LT", "LU", "LV", "MA", "MD", "MM", "MT", "MX", "MY", "NG", "NL", "NO", "NZ", "PA", "PE", "PH", "PK", "PL", "PR", "PT", "PY", "RO", "RU", "SA", "SE", "SG", "SI", "SK", "SV", "TH", "TR", "TW", "UA", "US", "UY", "VE", "VI", "VN", "ZA" ] }, "currency": { "type": "string", "description": "The office's billing currency.", "enum": [ "AUD", "CAD", "EUR", "GBP", "JPY", "NZD", "USD" ] }, "e911_address": { "type": "object", "description": "E911 Address", "properties": { "address": { "type": "string", "description": "[single-line only] Line 1 of the E911 address." }, "address2": { "type": "string", "description": "[single-line only] Line 2 of the E911 address." }, "city": { "type": "string", "description": "[single-line only] City of the E911 address." }, "country": { "type": "string", "description": "Country of the E911 address." }, "state": { "type": "string", "description": "[single-line only] State or Province of the E911 address." }, "zip": { "type": "string", "description": "[single-line only] Zip code of the E911 address." } }, "required": [ "address", "city", "country", "state", "zip" ] }, "first_action": { "type": [ "string", "null" ], "description": "The desired action when the office receives a call.", "enum": [ "menu", "operators" ] }, "friday_hours": { "type": "array", "items": { "type": "string" }, "description": "The Friday hours of operation. Default value is [\"08:00\", \"18:00\"]." }, "group_description": { "type": [ "string", "null" ], "description": "The description of the office. Max 256 characters." }, "hours_on": { "type": [ "boolean", "null" ], "description": "The time frame when the office wants to receive calls. Default value is false, which means the office will always take calls (24/7)." }, "international_enabled": { "type": [ "boolean", "null" ], "description": "A flag indicating if the primary office is able to make international phone calls." }, "invoiced": { "type": "boolean", "description": "A flag indicating if the payment will be paid by invoice." }, "mainline_number": { "type": [ "string", "null" ], "description": "The mainline of the office." }, "monday_hours": { "type": "array", "items": { "type": "string" }, "description": "The Monday hours of operation. To specify when hours_on is set to True. e.g. [\"08:00\", \"12:00\", \"14:00\", \"18:00\"] => open from 8AM to Noon, and from 2PM to 6PM. Default value is [\"08:00\", \"18:00\"]." }, "name": { "type": "string", "description": "[single-line only] The office name." }, "no_operators_action": { "type": [ "string", "null" ], "description": "The action to take if there is no one available to answer calls.", "enum": [ "ai_agent", "bridge_target", "call_service_target", "company_directory", "department", "directory", "disabled", "extension", "google_dialogflow", "last_name_company_directory", "last_name_directory", "menu", "message", "operator", "person", "recursive_transfer", "scripted_ivr", "voicemail" ] }, "plan_period": { "type": "string", "description": "The frequency at which the company will be billed.", "enum": [ "monthly", "yearly" ] }, "ring_seconds": { "type": [ "integer", "null" ], "description": "The number of seconds to allow the group line to ring before going to voicemail. Choose from 10 seconds to 45 seconds." }, "routing_options": { "type": "object", "description": "Routing Options", "properties": { "closed": { "type": "object", "description": "The closed value" }, "open": { "type": "object", "description": "The open value" } }, "required": [ "closed", "open" ] }, "saturday_hours": { "type": "array", "items": { "type": "string" }, "description": "The Saturday hours of operation. Default is empty array." }, "sunday_hours": { "type": "array", "items": { "type": "string" }, "description": "The Sunday hours of operation. Default is empty array." }, "thursday_hours": { "type": "array", "items": { "type": "string" }, "description": "The Thursday hours of operation. Default value is [\"08:00\", \"18:00\"]." }, "timezone": { "type": [ "string", "null" ], "description": "Timezone using a tz database name." }, "tuesday_hours": { "type": "array", "items": { "type": "string" }, "description": "The Tuesday hours of operation. Default value is [\"08:00\", \"18:00\"]." }, "unified_billing": { "type": "boolean", "description": "A flag indicating if to send a unified invoice." }, "use_same_address": { "type": [ "boolean", "null" ], "description": "A flag indicating if the billing address and the emergency address are the same." }, "voice_intelligence": { "type": "object", "description": "Voice Intelligence", "properties": { "allow_pause": { "type": "boolean", "description": "Allow individual users to start and stop Vi during calls. Default is True." }, "auto_start": { "type": "boolean", "description": "Auto start Vi for this call center. Default is True." } } }, "wednesday_hours": { "type": "array", "items": { "type": "string" }, "description": "The Wednesday hours of operation. Default value is [\"08:00\", \"18:00\"]." } }, "required": [ "PCID", "annual_commit_monthly_billing", "billing_address", "country", "currency", "invoiced", "name", "plan_period", "unified_billing" ] } ``` *** ## dialpad\_organization\_offices\_e911\_get E911 Address -- Get **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------- | -------- | ------- | ---------------- | | `id` | integer | Yes | — | The office's id. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "integer", "description": "The office's id." } }, "required": [ "PCID", "id" ] } ``` *** ## dialpad\_organization\_offices\_e911\_update E911 Address -- Update **Parameters:** | Parameter | Type | Required | Default | Description | | | ---------------------- | ------- | -------- | ------- | --------------------------------------------------------------- | ------------------------------------------------------------- | | `id` | integer | Yes | — | The office's id. | | | `address` | string | Yes | — | \[single-line only] Line 1 of the new E911 address. | | | `address2` | string | null | No | — | \[single-line only] Line 2 of the new E911 address. | | `city` | string | Yes | — | \[single-line only] City of the new E911 address. | | | `country` | string | Yes | — | Country of the new E911 address. | | | `state` | string | Yes | — | \[single-line only] State or Province of the new E911 address. | | | `update_all` | boolean | null | No | — | Update E911 for all users in this office. | | `use_validated_option` | boolean | null | No | — | Whether to use the validated address option from our service. | | `zip` | string | Yes | — | \[single-line only] Zip code of the new E911 address. | | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "integer", "description": "The office's id." }, "address": { "type": "string", "description": "[single-line only] Line 1 of the new E911 address." }, "address2": { "type": [ "string", "null" ], "description": "[single-line only] Line 2 of the new E911 address." }, "city": { "type": "string", "description": "[single-line only] City of the new E911 address." }, "country": { "type": "string", "description": "Country of the new E911 address." }, "state": { "type": "string", "description": "[single-line only] State or Province of the new E911 address." }, "update_all": { "type": [ "boolean", "null" ], "description": "Update E911 for all users in this office." }, "use_validated_option": { "type": [ "boolean", "null" ], "description": "Whether to use the validated address option from our service." }, "zip": { "type": "string", "description": "[single-line only] Zip code of the new E911 address." } }, "required": [ "PCID", "id", "address", "city", "country", "state", "zip" ] } ``` *** ## dialpad\_organization\_offices\_get Office -- Get **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------- | -------- | ------- | ---------------- | | `id` | integer | Yes | — | The office's id. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "integer", "description": "The office's id." } }, "required": [ "PCID", "id" ] } ``` *** ## dialpad\_organization\_offices\_list Office -- 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. | | `active_only` | boolean | No | — | Whether we only return active offices. | ```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." }, "active_only": { "type": "boolean", "description": "Whether we only return active offices." } }, "required": [ "PCID" ] } ``` *** ## dialpad\_organization\_offices\_offdutystatuses\_get Off-Duty Status -- List **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------- | -------- | ------- | ---------------- | | `id` | integer | Yes | — | The office's id. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "integer", "description": "The office's id." } }, "required": [ "PCID", "id" ] } ``` *** ## dialpad\_organization\_offices\_operators\_delete Operator -- Remove **Parameters:** | Parameter | Type | Required | Default | Description | | --------------- | ------- | -------- | ------- | -------------------------------------------------- | | `id` | integer | Yes | — | The office's ID. | | `operator_id` | integer | Yes | — | ID of the operator to remove. | | `operator_type` | string | Yes | — | Type of the operator to remove (`user` or `room`). | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "integer", "description": "The office's ID." }, "operator_id": { "type": "integer", "description": "ID of the operator to remove." }, "operator_type": { "type": "string", "description": "Type of the operator to remove (`user` or `room`).", "enum": [ "room", "user" ] } }, "required": [ "PCID", "id", "operator_id", "operator_type" ] } ``` *** ## dialpad\_organization\_offices\_operators\_get Operator -- List **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------- | -------- | ------- | ---------------- | | `id` | integer | Yes | — | The office's id. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "integer", "description": "The office's id." } }, "required": [ "PCID", "id" ] } ``` *** ## dialpad\_organization\_offices\_operators\_post Operator -- Add **Parameters:** | Parameter | Type | Required | Default | Description | | | --------------- | ------- | -------- | ------- | ----------------------------------------------- | ----------------------------------------------------- | | `id` | integer | Yes | — | The office's ID. | | | `operator_id` | integer | Yes | — | ID of the operator to add. | | | `operator_type` | string | Yes | — | Type of the operator to add. (`user` or `room`) | | | `role` | string | null | No | — | The role of the new operator. (`operator` or `admin`) | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "integer", "description": "The office's ID." }, "operator_id": { "type": "integer", "description": "ID of the operator to add." }, "operator_type": { "type": "string", "description": "Type of the operator to add. (`user` or `room`)", "enum": [ "room", "user" ] }, "role": { "type": [ "string", "null" ], "description": "The role of the new operator. (`operator` or `admin`)", "enum": [ "admin", "operator" ] } }, "required": [ "PCID", "id", "operator_id", "operator_type" ] } ``` *** ## dialpad\_organization\_offices\_primary\_get Office -- Get Primary ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" } }, "required": [ "PCID" ] } ``` *** ## dialpad\_organization\_offices\_update Office -- Update **Parameters:** | Parameter | Type | Required | Default | Description | | | ----------------- | --------- | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | integer | Yes | — | The office's id. | | | `friday_hours` | string\[] | No | — | The Friday hours of operation. Default value is \["08:00", "18:00"]. | | | `hours_on` | boolean | null | No | — | The time frame when the department wants to receive calls. Default value is false, which means the call center will always take calls (24/7). | | `monday_hours` | string\[] | No | — | The Monday hours of operation. To specify when hours\_on is set to True. e.g. \["08:00", "12:00", "14:00", "18:00"] => open from 8AM to Noon, and from 2PM to 6PM. Default value is \["08:00", "18:00"]. | | | `saturday_hours` | string\[] | No | — | The Saturday hours of operation. Default is empty array. | | | `sunday_hours` | string\[] | No | — | The Sunday hours of operation. Default is empty array. | | | `thursday_hours` | string\[] | No | — | The Thursday hours of operation. Default value is \["08:00", "18:00"]. | | | `tuesday_hours` | string\[] | No | — | The Tuesday hours of operation. Default value is \["08:00", "18:00"]. | | | `wednesday_hours` | string\[] | No | — | The Wednesday hours of operation. Default value is \["08:00", "18:00"]. | | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "integer", "description": "The office's id." }, "friday_hours": { "type": "array", "items": { "type": "string" }, "description": "The Friday hours of operation. Default value is [\"08:00\", \"18:00\"]." }, "hours_on": { "type": [ "boolean", "null" ], "description": "The time frame when the department wants to receive calls. Default value is false, which means the call center will always take calls (24/7)." }, "monday_hours": { "type": "array", "items": { "type": "string" }, "description": "The Monday hours of operation. To specify when hours_on is set to True. e.g. [\"08:00\", \"12:00\", \"14:00\", \"18:00\"] => open from 8AM to Noon, and from 2PM to 6PM. Default value is [\"08:00\", \"18:00\"]." }, "saturday_hours": { "type": "array", "items": { "type": "string" }, "description": "The Saturday hours of operation. Default is empty array." }, "sunday_hours": { "type": "array", "items": { "type": "string" }, "description": "The Sunday hours of operation. Default is empty array." }, "thursday_hours": { "type": "array", "items": { "type": "string" }, "description": "The Thursday hours of operation. Default value is [\"08:00\", \"18:00\"]." }, "tuesday_hours": { "type": "array", "items": { "type": "string" }, "description": "The Tuesday hours of operation. Default value is [\"08:00\", \"18:00\"]." }, "wednesday_hours": { "type": "array", "items": { "type": "string" }, "description": "The Wednesday hours of operation. Default value is [\"08:00\", \"18:00\"]." } }, "required": [ "PCID", "id" ] } ``` *** ## dialpad\_organization\_plan\_available\_licenses\_get Licenses -- List Available **Parameters:** | Parameter | Type | Required | Default | Description | | ----------- | ------- | -------- | ------- | ---------------- | | `office_id` | integer | Yes | — | The office's id. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "office_id": { "type": "integer", "description": "The office's id." } }, "required": [ "PCID", "office_id" ] } ``` *** ## dialpad\_organization\_plan\_get Billing Plan -- Get **Parameters:** | Parameter | Type | Required | Default | Description | | ----------- | ------- | -------- | ------- | ---------------- | | `office_id` | integer | Yes | — | The office's id. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "office_id": { "type": "integer", "description": "The office's id." } }, "required": [ "PCID", "office_id" ] } ``` *** ## dialpad\_organization\_rooms\_delete Room -- Delete **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------- | -------- | ------- | -------------- | | `id` | integer | Yes | — | The room's id. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "integer", "description": "The room's id." } }, "required": [ "PCID", "id" ] } ``` *** ## dialpad\_organization\_rooms\_get Room -- Get **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------- | -------- | ------- | -------------- | | `id` | integer | Yes | — | The room's id. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "integer", "description": "The room's id." } }, "required": [ "PCID", "id" ] } ``` *** ## dialpad\_organization\_rooms\_list Room -- 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. | | `office_id` | integer | No | — | The office'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." }, "office_id": { "type": "integer", "description": "The office's id." } }, "required": [ "PCID" ] } ``` *** ## dialpad\_organization\_rooms\_patch Room -- Update **Parameters:** | Parameter | Type | Required | Default | Description | | | --------------- | --------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------ | | `id` | integer | Yes | — | The room's id. | | | `name` | string | null | No | — | \[single-line only] The name of the room. | | `phone_numbers` | string\[] | No | — | A list of all phone numbers assigned to the room. Numbers can be re-ordered or removed from this list to unassign them. | | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "integer", "description": "The room's id." }, "name": { "type": [ "string", "null" ], "description": "[single-line only] The name of the room." }, "phone_numbers": { "type": "array", "items": { "type": "string" }, "description": "A list of all phone numbers assigned to the room. Numbers can be re-ordered or removed from this list to unassign them." } }, "required": [ "PCID", "id" ] } ``` *** ## dialpad\_organization\_rooms\_post Room -- Create **Parameters:** | Parameter | Type | Required | Default | Description | | ----------- | ------- | -------- | ------- | ------------------------------------------ | | `name` | string | Yes | — | \[single-line only] The name of the room. | | `office_id` | integer | Yes | — | The office in which this room resides. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "name": { "type": "string", "description": "[single-line only] The name of the room." }, "office_id": { "type": "integer", "description": "The office in which this room resides." } }, "required": [ "PCID", "name", "office_id" ] } ```