Skip to main content
New to Corsair? See API access, authentication, and error handling.

Accesscontrolpolicies

assign

accesscontrolpolicies.assign Access Control Policies — Assign. Assigns a user to an access control policy. Requires a company admin API key. Rate limit: 1200 per minute. Risk: write
Input
Output

assignments

accesscontrolpolicies.assignments Access Control Policies — List Assignments. Lists all users assigned to this access control policy. Rate limit: 1200 per minute. Risk: read
Input
Output

create

accesscontrolpolicies.create Access Control Policies — Create. Creates a new custom access control policy. Requires a company admin API key. Rate limit: 1200 per minute. Risk: write
Input
Output

delete

accesscontrolpolicies.delete Access Control Policies — Delete. Deletes a policy by marking the state as deleted, and removing all associated users. Requires a company admin API key. Rate limit: 1200 per minute. Risk: destructive
Input
Output

get

accesscontrolpolicies.get Access Control Policies — Get. Get a specific access control policy’s details. Rate limit: 1200 per minute. Risk: read
Input
Output

list

accesscontrolpolicies.list Access Control Policies — List Policies. Gets all access control policies belonging to the company. Rate limit: 1200 per minute. Risk: read
Input
Output

unassign

accesscontrolpolicies.unassign Access Control Policies — Unassign. Unassigns one or all target groups associated with the user for an access control policy. Requires a company admin API key. Rate limit: 1200 per minute. Risk: write
Input
Output

update

accesscontrolpolicies.update Access Control Policies — Update. Updates the provided fields for an existing access control policy. Requires a company admin API key. Rate limit: 1200 per minute. Risk: write
Input
Output

Agentgroup

get

agentgroup.get Agent Group — Get. Requires scope: agent_groups:read Rate limit: 1200 per minute. Risk: read
Input
Output

Anonymization

callcontent

anonymization.callcontent Call Content — Delete (Bulk). Removes call recordings, screen recordings, transcripts, and AI data from the specified calls. The call records themselves are preserved. This operation is asynchronous — queues a task and returns a request_id for status polling. Rate limit: 10 per minute. Risk: destructive
Input
Output

contacts

anonymization.contacts Anonymize — Contacts (Bulk). Anonymizes the specified contacts by removing all PII (name, phone, email, etc). Call recordings and AI data associated with these contacts are also removed. This operation is asynchronous — queues one task per contact and returns a request_id for status polling. Rate limit: 10 per minute. Risk: destructive
Input
Output

requests.get

anonymization.requests.get Anonymization Request — Get. Returns the current status of an anonymization request. Rate limit: 1200 per minute. Risk: read
Input
Output

App Settings

get

app_settings.get App Settings — Get. Gets the app settings of the OAuth app that is associated with the API key for the target, if target_type and target_id are provided. Otherwise, will return the app settings for the company. Rate limit: 1200 per minute. Risk: read
Input
Output

Available Licenses

list

available_licenses.list Licenses — List Available. Gets how many licenses of each line type an office has purchased but not yet assigned, so a count of zero for a line type means a new user or room of that type cannot be added without buying more. Rate limit: 1200 per minute. Risk: read
Input
Output

Available Numbers

list

available_numbers.list Dialpad Number — List Available. Searches the phone numbers that are available to assign, in the country of the user’s office. Search by area code, city or the first digits of a number, and page through the results with the cursor. The search has these fallbacks: - A toll-free search with no matches returns any available toll-free numbers instead. - For a US search that has run out of results, the response lists overlaying_area_codes: other area codes that serve the same region, to search next. - When nothing matches an international search, set country_fallback to get numbers from the whole country instead; the response then has search_extended_to_country set. Requires a user API key. Rate limit: 1200 per minute. Risk: read
Input
Output

Blockednumbers

add

blockednumbers.add Blocked Number — Add. Blocks the given phone numbers company-wide, so that inbound calls and texts from them are rejected for every user in the company. Returns no content on success. Blocking is reversible via the remove endpoint. Rate limit: 1200 per minute. Risk: write
Input
Output: any

get

blockednumbers.get Blocked Number — Get. Checks whether a single phone number is blocked company-wide. Returns the number if it is blocked, and 404s if it is not blocked or was blocked outside the API. Rate limit: 1200 per minute. Risk: read
Input
Output

list

blockednumbers.list Blocked Numbers — List. Lists the phone numbers blocked company-wide through the API. Numbers blocked by other means are not included. Rate limit: 1200 per minute. Risk: read
Input
Output

remove

blockednumbers.remove Blocked Number — Remove. Unblocks the given phone numbers company-wide, restoring inbound calls and texts from them. Returns no content on success. Rate limit: 1200 per minute. Risk: write
Input
Output: any

Bulk Messages

get

bulk_messages.get Bulk Message — Get. Gets a single bulk message by ID. Rate limit: 1200 per minute. Risk: read
Input
Output

list

bulk_messages.list Bulk Message — List. Lists all bulk messages for the authenticated user. Results can be paginated using the cursor parameter. Rate limit: 1200 per minute. Risk: read
Input
Output

send

bulk_messages.send Bulk Message — Send. Sends a bulk message to multiple recipients (up to 50). This endpoint allows you to send the same message to multiple phone numbers. All existing logic (including spam checks, delivery behavior, and visibility in the Bulk Messages UI tab) will remain the same for API-triggered sends. Important: Message sending is asynchronous. This endpoint creates the bulk message batch and returns immediately with success=True, indicating the batch was created successfully. Individual messages are sent in the background. To check the delivery status of individual recipients, use the GET /message/bulk/{id} endpoint to retrieve the batch with delivery status information (attempted_send, error_message, delivery_status fields per recipient). Rate limit: 1200 per minute. Risk: destructive
Input
Output

update

bulk_messages.update Bulk Message — Update. Updates a bulk message text and/or media. Supports partial updates. Only the fields provided in the request will be updated. Fields not provided will retain their existing values. This follows PATCH semantics. Rate limit: 1200 per minute. Risk: write
Input
Output

Call

add_labels

call.add_labels Label — Add. Adds labels to a determined call id, keeping any labels already on the call. A label already present is not duplicated. Labels cannot be removed through this endpoint. Rate limit: 250 per minute. Risk: write
Input
Output

assign

call.assign Call — Assign Operator. Assigns an operator to a call queued in a contact center. Only contact center calls are eligible for this operation. Currently supports assigning one operator per request. Rate limit: 12 per minute. Risk: write
Input
Output

get_ai_recap

call.get_ai_recap Call — Get Ai Recap. Gets the Ai Recap for a call. Requires scope: ai_recap Rate limit: 12 per minute. Risk: read
Input
Output

get_assigned_operators

call.get_assigned_operators Call — Assigned Operators. Get all assigned operators from a call queued in a contact center. Only contact center calls are eligible for this operation. Rate limit: 250 per minute. Risk: read
Input
Output

get_call_info

call.get_call_info Call — Get. Get call status and detailed information for a concluded call, including direction, duration, recording URLs, CSAT scores, voicemail metadata, and transcription text. Also returns routing_breadcrumbs, which is only populated for calls routed through a customer-configured API Call Router and is empty for every other call. Rate limit: 10 per minute. Risk: read
Input
Output

hangup

call.hangup Call Actions — Hang up. Hangs up the call. Rate limit: 1200 per minute. Risk: destructive
Input
Output: any

initiate

call.initiate Call — Initiate via Ring. Initiates an outbound call to ring all devices (or a single specified device). Note that the user must have at least one active device (a web, desktop or mobile Dialpad app; a CTI application; or a physical deskphone). Rate limit: 5 per minute. Risk: destructive
Input
Output

initiate_ivr_call

call.initiate_ivr_call Call — Initiate IVR Call. Initiates an outbound call to ring an IVR Workflow. Rate limit: 10 per minute per IVR. Rate limit: 1200 per minute. Risk: destructive
Input
Output

list

call.list Call — List. Provides a paginated list of calls matching the specified filter parameters in reverse-chronological order by call start time (i.e. recent calls first) Note: This API will only include calls that have already concluded. When no target is specified, company-level API keys and company admins list all of the company’s calls, and other user-level API keys list the authenticated user’s own calls. Requires scope: calls:list Rate limit: 1200 per minute. Risk: read
Input
Output

participants.add

call.participants.add Call — Add Participant. Adds another participant to a call. Valid methods to add are by phone or by target. Targets require to have a primary phone Rate limit: 1200 per minute. Risk: destructive
Input
Output

transfer_call

call.transfer_call Call — Transfer. Transfers call to another recipient. Rate limit: 1200 per minute. Risk: destructive
Input
Output

unassign_all_call_operators

call.unassign_all_call_operators Call — Unassign All Call Operators. Unassigns all assigned operators from a call queued in a contact center. Only contact center calls are eligible for this operation. Rate limit: 12 per minute. Risk: write
Input
Output

unassign_operator

call.unassign_operator Call — Unassign Call Operator. Unassigns an operator from a call queued in a contact center. Only contact center calls are eligible for this operation. Currently supports unassigning one specific operator per request. Rate limit: 12 per minute. Risk: write
Input
Output

unpark

call.unpark Call — Unpark. Unparks a call previously parked on an Office mainline, routing it to the specified user. Rate limit: 1200 per minute. Risk: write
Input
Output

Call Labels

list

call_labels.list Label — List. Gets all labels for a determined company. Rate limit: 1200 per minute. Risk: read
Input
Output

create

call_review_share_link.create Call Review Sharelink — Create. Create a call review share link by call id. Rate limit: 250 per minute. Risk: write
Input
Output

delete

call_review_share_link.delete Call Review Sharelink — Delete. Delete a call review share link by id. Rate limit: 1200 per minute. Risk: destructive
Input
Output

get

call_review_share_link.get Call Review Sharelink — Get. Gets a call review share link by call id. Rate limit: 1200 per minute. Risk: read
Input
Output

update

call_review_share_link.update Call Review Sharelink — Update. Update a call review share link by id. Rate limit: 250 per minute. Risk: write
Input
Output

Callback

enqueue

callback.enqueue Call Back — Enqueue. Requests a call back to a given number by an operator in a given call center, and returns the request’s position in the queue. The call back joins the call center queue like a regular call and dials out when the next operator becomes available, respecting the call center’s business and holiday hours and queue settings. International call backs are not supported, and a duplicate call back for the same number and call center is rejected. Rate limit: 1200 per minute. Risk: destructive
Input
Output

validate

callback.validate Call Back — Validate. Performs a dry run of a callback request without adding it to the call center queue and without placing any call. Runs the same validation as enqueuing would, so it reports the same failures (unreachable number, international destination, duplicate request, call center closed) up front. Returns whether the request would succeed. Rate limit: 1200 per minute. Risk: write
Input
Output

Callbacks

list

callbacks.list Call Back — List. Lists the callback requests waiting in a call center’s queue, oldest first, so the first result has been waiting longest. Each callback reports the number to call back, when it was queued, and a status that is either “queued” while the request is still waiting for an operator or “timed_out” once it waited longer than the call center’s max_hold_seconds. Queued callbacks carry their position in the queue; timed-out ones do not. The API key must have admin rights on the specified call center; this is a per-call-center check rather than a company-wide admin requirement. Rate limit: 1200 per minute. Risk: read
Input
Output

Callcenters

create

callcenters.create Call Centers — Create. Create a new call center in the specified office. Requires name and office_id. Requires a company admin API key. Rate limit: 1200 per minute. Risk: write
Input
Output

delete

callcenters.delete Call Centers — Delete. Deletes a call center by id. Requires a company admin API key. Rate limit: 1200 per minute. Risk: destructive
Input
Output

get

callcenters.get Call Centers — Get. Gets a call center by id. Rate limit: 1200 per minute. Risk: read
Input
Output

get_status

callcenters.get_status Call Centers — Status. Get live operational metrics for a call center: availability status, available operator count, queued calls, longest wait time, and on-duty operator count. Rate limit: 1200 per minute. Risk: read
Input
Output

list

callcenters.list Call Centers — List. Gets all the call centers for an office. Rate limit: 1200 per minute. Risk: read
Input
Output

listall

callcenters.listall Call Centers — List. Gets all the call centers for the company. Rate limit: 1200 per minute. Risk: read
Input
Output

operators.add

callcenters.operators.add Operator — Add. Adds an operator to a call center. > Warning > > This API may result in the usage of call center licenses if required and available. If the licenses are required and not available the operation will fail. Licenses are required when adding an operator that does not have a call center license. Rate limit: 1200 per minute. Risk: destructive
Input
Output

operators.delete

callcenters.operators.delete Operator — Remove. Removes an operator from a call center. Note: This API will not change or release any licenses. Rate limit: 1200 per minute. Risk: destructive
Input
Output

operators.get_duty_status

callcenters.operators.get_duty_status Operator — Get Duty Status. Gets the operator’s on duty status and reason. Rate limit: 1200 per minute. Risk: read
Input
Output

operators.get_skill_level

callcenters.operators.get_skill_level Operator — Get Skill Level. Gets the skill level of an operator within a call center. Rate limit: 1200 per minute. Risk: read
Input
Output

operators.list

callcenters.operators.list Operators — List. List all operators (users and rooms) assigned to a call center. Returns operator names, roles, and on-duty status. Rate limit: 1200 per minute. Risk: read
Input
Output

operators.update_duty_status

callcenters.operators.update_duty_status Operator — Update Duty Status. Updates the operator’s duty status for all call centers which user belongs to. Rate limit: 1200 per minute. Risk: write
Input
Output

operators.update_skill_level

callcenters.operators.update_skill_level Operator — Update Skill Level. Updates the skill level of an operator within a call center. Rate limit: 1200 per minute. Risk: write
Input
Output

queue.list

callcenters.queue.list Call Centers — Queue. List the calls and callbacks currently waiting in a call center’s queue, ordered oldest-queued first. Includes calls that are ringing an operator but not yet answered. Rate limit: 30 per minute. Risk: read
Input
Output

update

callcenters.update Call Centers — Update. Updates a call center by id. Requires a company admin API key. Rate limit: 1200 per minute. Risk: write
Input
Output

Caller Id

users.get

caller_id.users.get Caller ID — Get. List all available Caller IDs and the active Caller ID for a given user ID Rate limit: 1200 per minute. Risk: read
Input
Output

Callrouters

create

callrouters.create Call Router — Create. Creates a new API-based call router. Rate limit: 1200 per minute. Risk: write
Input
Output

delete

callrouters.delete Call Router — Delete. Deletes the API call router with the given ID. Rate limit: 1200 per minute. Risk: destructive
Input
Output: any

get

callrouters.get Call Router — Get. Gets the API call router with the given ID. Rate limit: 1200 per minute. Risk: read
Input
Output

list

callrouters.list Call Router — List. Lists all of the API call routers for a given company or office. Rate limit: 1200 per minute. Risk: read
Input
Output

update

callrouters.update Call Router — Update. Updates the API call router with the given ID. Rate limit: 1200 per minute. Risk: write
Input
Output

Channels

create

channels.create Channel — Create. Creates a new channel. Rate limit: 1200 per minute. Risk: write
Input
Output

delete

channels.delete Channel — Delete. Deletes a channel by id. Rate limit: 1200 per minute. Risk: destructive
Input
Output: any

get

channels.get Channel — Get. Get channel by id Rate limit: 1200 per minute. Risk: read
Input
Output

list

channels.list Channel — List. Lists all channels in the company. Rate limit: 1200 per minute. Risk: read
Input
Output

members.add

channels.members.add Member — Add. Adds a user to a channel. Rate limit: 1200 per minute. Risk: write
Input
Output

members.delete

channels.members.delete Member — Remove. Removes a member from a channel. Rate limit: 1200 per minute. Risk: destructive
Input
Output: any

members.list

channels.members.list Members — List. List all the members from a channel Rate limit: 1200 per minute. Risk: read
Input
Output

Coaching Team

get

coaching_team.get Coaching Team — Get. Get details of a specified coaching team. Rate limit: 1200 per minute. Risk: read
Input
Output

list

coaching_team.list Coaching Team — List. Get a list of coaching teams of a office. Rate limit: 1200 per minute. Risk: read
Input
Output

listall

coaching_team.listall Coaching Team — List. Get a list of all coaching teams in the company. Rate limit: 1200 per minute. Risk: read
Input
Output

members.add

coaching_team.members.add Coaching Team — Add Member. Add a user to the specified coaching team as trainee or coach. Rate limit: 1200 per minute. Risk: write
Input
Output

members.get

coaching_team.members.get Coaching Team — List Members. List all members of a coaching team with their roles (coach or trainee), contact info, and availability status. Rate limit: 1200 per minute. Risk: read
Input
Output

Company

get

company.get Company — Get. Gets company information: name, primary office, admin contact, plan state and billing address. Rate limit: 1200 per minute. Risk: read
Input: empty object Output

get_ai_settings

company.get_ai_settings Company — Get AI Settings. Gets the company-level AI settings: whether Call AI is enabled and whether the company allows its data to be used for AI training. Rate limit: 1200 per minute. Risk: read
Input: empty object Output

sms_opt_out

company.sms_opt_out Company — Get SMS Opt-out List. Lists the external phone numbers that have opted out of (or back in to) SMS from this company, filtered by opt-out state and optionally by A2P campaign. Use this before sending SMS to confirm a recipient has not opted out. Requires a company admin API key. Rate limit: 250 per minute. Risk: read
Input
Output

update

company.update Company — Update. Updates the company’s name. For a company with a single office, the office is renamed too. Only an admin of the company acting as a user can call this: a missing user credential gets a 401, and a user who is not an admin of this company gets a 403. Rate limit: 1200 per minute. Risk: write
Input
Output

update_ai_settings

company.update_ai_settings Company — Update AI Settings. Updates the company-level AI settings, and syncs the change to the enterprise the same way the admin portal does. Settings that are omitted are left unchanged, and a setting cannot be cleared, so an explicit null is rejected with a 400, as is a request that sets nothing. A company-level API key can call this without a user credential. Any other caller must be a company admin, the admin of a single-office company, or have write access to AI settings: a missing user credential gets a 401, and any other caller gets a 403. Rate limit: 1200 per minute. Risk: write
Input
Output

update_settings

company.update_settings Company — Update Settings. Updates company settings. Requires a company admin API key. Rate limit: 1200 per minute. Risk: write
Input
Output

Contacts

create

contacts.create Contact — Create. Creates a new contact. Rate limit: 100 per minute. Risk: write
Input
Output

create_with_uid

contacts.create_with_uid Contact — Create or Update. Creates a new shared contact with uid. Rate limit: 100 per minute. Risk: write
Input
Output

delete

contacts.delete Contact — Delete. Deletes a contact by id. Rate limit: 1200 per minute. Risk: destructive
Input
Output

get

contacts.get Contact — Get. Gets a contact by id. Currently, only contacts of type shared and local can be retrieved by this API. Rate limit: 1200 per minute. Risk: read
Input
Output

list

contacts.list Contact — List. Gets company shared contacts, or user’s local contacts if owner_id is provided. NOTE: The limit parameter has been soft-deprecated. Please omit the limit parameter, or reduce it to 100 or less. - Limit values of greater than 100 will only produce a page size of 100, and a 400 Bad Request response will be produced 20% of the time in an effort to raise visibility of side-effects that might otherwise go un-noticed by solutions that had assumed a larger page size. - The cursor value is provided in the response, and can be passed as a parameter to retrieve subsequent pages of results. Rate limit: 1200 per minute. Risk: read
Input
Output
contacts.search Contact — Search. Searches local, shared, and lead contacts the API key may read within its company. All filters must match (AND). Contacts sharing an identifier are returned separately. Results may lag behind updates. A short or empty page may still include a next-page cursor. Empty items and external_ids are omitted. The cursor is omitted when the search is complete. Rate limit: 1200 per minute. Risk: read
Input
Output

update

contacts.update Contact — Update. Updates the provided fields for an existing contact. Rate limit: 1200 per minute. Risk: write
Input
Output

Custom Ivrs

list

custom_ivrs.list Custom IVR — List. Lists the custom IVR recordings configured on a target, such as greetings, hold music and menu prompts. A target can have many IVRs of different types, so pass ivr_type to narrow the results to one kind. Rate limit: 1200 per minute. Risk: read
Input
Output

Departments

create

departments.create Departments — Create. Create a new department in the specified office. Requires name and office_id. Requires a company admin API key. Rate limit: 1200 per minute. Risk: write
Input
Output

delete

departments.delete Departments — Delete. Permanently delete a department. This removes the department and all its configuration. Cannot be undone. Requires a company admin API key. Rate limit: 1200 per minute. Risk: destructive
Input
Output

get

departments.get Department — Get. Gets a department by id. Rate limit: 1200 per minute. Risk: read
Input
Output

list

departments.list Department — List. Gets all the departments for an office. Rate limit: 1200 per minute. Risk: read
Input
Output

listall

departments.listall Department — List. Gets all the departments in the company. Rate limit: 1200 per minute. Risk: read
Input
Output

operators.add

departments.operators.add Operator — Add. Add a user or room as an operator to a department. Specify operator_type (user or room) and optional role (operator or admin). Rate limit: 1200 per minute. Risk: write
Input
Output

operators.delete

departments.operators.delete Operator — Remove. Remove an operator (user or room) from a department. Specify operator_id and operator_type. Rate limit: 1200 per minute. Risk: destructive
Input
Output

operators.list

departments.operators.list Operator — List. List all operators (users and rooms) assigned to a department. Returns operator names, roles, and on-duty status. Rate limit: 1200 per minute. Risk: read
Input
Output

update

departments.update Departments — Update. Updates an existing department. Requires a company admin API key. Rate limit: 1200 per minute. Risk: write
Input
Output

Deskphones

rooms.create_international_pin

deskphones.rooms.create_international_pin Room Phone — Assign PIN. Assigns a PIN for making international calls from rooms When PIN protected international calls are enabled for the company, a PIN is required to make international calls from room phones. Requires a company admin API key. Rate limit: 1200 per minute. Risk: write
Input
Output

rooms.delete

deskphones.rooms.delete Room Phone — Delete. Deletes a room desk phone by id. Rate limit: 1200 per minute. Risk: destructive
Input
Output: any

rooms.get

deskphones.rooms.get Room Phone — Get. Gets a room desk phone by id. Rate limit: 1200 per minute. Risk: read
Input
Output

rooms.list

deskphones.rooms.list Room Phone — List. Gets all desk phones under a room. Rate limit: 1200 per minute. Risk: read
Input
Output

users.delete

deskphones.users.delete Desk Phone — Delete. Deletes a user desk phone by id. Rate limit: 1200 per minute. Risk: destructive
Input
Output: any

users.get

deskphones.users.get Desk Phone — Get. Gets a user desk phone by id. Rate limit: 1200 per minute. Risk: read
Input
Output

users.list

deskphones.users.list Desk Phone — List. Gets all desk phones under a user. Rate limit: 1200 per minute. Risk: read
Input
Output

Digital

sessions.list

digital.sessions.list Digital — Sessions — List. Gets list of digital sessions which are started/ended in the requested period. Requested period must be less than 7 days. Requires scope: digital_sessions Rate limit: 100 per minute. Risk: read
Input
Output

Dispositions

create

dispositions.create Dispositions — Create. Creates a disposition for an office. Rate limit: 1200 per minute. Risk: write
Input
Output

delete

dispositions.delete Dispositions — Delete. Deletes the disposition by id. Rate limit: 1200 per minute. Risk: destructive
Input
Output: any

get

dispositions.get Dispositions — Get. Gets a disposition by id. Rate limit: 1200 per minute. Risk: read
Input
Output

list

dispositions.list Dispositions — List. Gets a list of dispositions by a target. Rate limit: 1200 per minute. Risk: read
Input
Output

update

dispositions.update Dispositions — Update. Updates the disposition by id. Bulk updates for the targets assigned to a disposition is not supported. Rate limit: 1200 per minute. Risk: write
Input
Output

Fax

send

fax.send Fax — Send. Sends a fax to a phone number. Rate limit: 250 per minute. Risk: destructive
Input
Output

Faxline

assign

faxline.assign Fax Line — Assign. Assigns a fax line to a target. Target includes user and department. Depending on the chosen line type, the number will be taken from the company’s reserved pool if there are available reserved numbers, otherwise numbers can be auto-assigned using a provided area code. Requires a company admin API key. Rate limit: 1200 per minute. Risk: destructive
Input
Output

Ivr

assign

ivr.assign Custom IVR — Assign. Assigns an already-created IVR recording to a target for a given IVR type, replacing whatever was previously assigned. This selects which existing recording plays; it does not change the recording’s own name or description. Rate limit: 1200 per minute. Risk: write
Input
Output

create

ivr.create Custom IVR — Create. Creates a new custom IVR recording for a target. The audio is supplied in the “file” field as a Base64-encoded MP3. Returns the created IVR, including the id needed to assign it to a target. Rate limit: 1200 per minute. Risk: write
Input
Output

delete

ivr.delete Custom IVR — Delete. Un-assigns an IVR recording from a target for a given IVR type and deletes the recording. The target falls back to its default behaviour for that IVR type. Rate limit: 1200 per minute. Risk: destructive
Input
Output

update_details

ivr.update_details Custom IVR — Update. Renames an existing IVR recording or changes its description. This edits the recording’s own metadata only; it does not change which target the recording is assigned to and does not replace the audio. Rate limit: 1200 per minute. Risk: write
Input
Output

Meetings

conference-meetings.list

meetings.conference-meetings.list Meeting Summary — List. Lists summaries of meetings that have occurred in the specified meeting room. Requires scope: conference:read Rate limit: 1200 per minute. Risk: read
Input
Output

conference-rooms.list

meetings.conference-rooms.list Meeting Room — List. Lists all conference rooms. Requires scope: conference:read Rate limit: 1200 per minute. Risk: read
Input
Output

meetings.create

meetings.meetings.create Dialpad Meeting — Create. Creates a Dialpad meeting. Requires scope: conference:all Rate limit: 1200 per minute. Risk: write
Input
Output

meetings.delete

meetings.meetings.delete Dialpad Meeting — Delete. Deletes a Dialpad meeting. Requires scope: conference:all Rate limit: 1200 per minute. Risk: destructive
Input
Output

meetings.get

meetings.meetings.get Dialpad Meeting — Get. Gets a Dialpad meeting. Requires scope: conference:all Rate limit: 1200 per minute. Risk: read
Input
Output

meetings.list

meetings.meetings.list Dialpad Meeting — List. Lists all Dialpad meetings for a specified user. Requires scope: conference:all Rate limit: 1200 per minute. Risk: read
Input
Output

meetings.room.create

meetings.meetings.room.create Meeting Room — Create. Creates a meeting room (personal or unique meeting). Requires scope: conference:all Rate limit: 1200 per minute. Risk: write
Input
Output

meetings.update

meetings.meetings.update Dialpad Meeting — Update. Updates a Dialpad meeting. Requires scope: conference:all Rate limit: 1200 per minute. Risk: write
Input
Output

Number Tags

update

number_tags.update Number Tags — Update tags for a phone number.. Sets the contact preferences for a phone number company-wide. “do_not_call” blocks outbound calls to the number and “do_not_text” blocks outbound texts. Returns the resulting preferences. Either preference can be turned back off by sending the opposite value. Requires a company admin API key. Rate limit: 1200 per minute. Risk: write
Input
Output

Numbers

assign

numbers.assign Dialpad Number — Assign. Assigns a specific phone number to a target. Use this when the number to assign is already known; use the auto-assign endpoint to let Dialpad pick one. Valid targets are a user or department, an office, room, callcenter, callrouter, staffgroup, channel or coachinggroup. Rate limit: 1200 per minute. Risk: destructive
Input
Output

assign_call_router_number.post

numbers.assign_call_router_number.post Dialpad Number — Assign. Assigns a number to a callrouter. The number will automatically be taken from the company’s reserved pool if there are reserved numbers, otherwise a number will be auto-assigned from the provided area code. Rate limit: 1200 per minute. Risk: destructive
Input
Output

assign_office_number.post

numbers.assign_office_number.post Dialpad Number — Assign. Assigns a number to a office. The number will automatically be taken from the company’s reserved pool if there are reserved numbers, otherwise a number will be auto-assigned from the provided area code. Rate limit: 1200 per minute. Risk: destructive
Input
Output

assign_room_number.post

numbers.assign_room_number.post Dialpad Number — Assign. Assigns a number to a room. The number will automatically be taken from the company’s reserved block if there are reserved numbers, otherwise a number will be auto-assigned from the provided area code. Rate limit: 1200 per minute. Risk: destructive
Input
Output

auto_assign

numbers.auto_assign Dialpad Number — Auto-Assign. Assigns an automatically selected phone number to a target and returns the number that was chosen. The number is taken from the company’s reserved pool if one exists, otherwise a new number is allocated from the provided area code. Use the assign endpoint instead when a specific number is required. Target includes user, department, office, room, callcenter and callrouter, plus staffgroup, channel and coachinggroup. Rate limit: 1200 per minute. Risk: destructive
Input
Output

get

numbers.get Dialpad Number — Get. Gets the details of a single phone number: its type, area code, status, and the target it is assigned to. Requires a company admin API key. Rate limit: 1200 per minute. Risk: read
Input
Output

list

numbers.list Dialpad Number — List. Lists the phone numbers in your company, each with its type, area code, status and the target it is assigned to. Filter by status to find numbers in a particular state, or by area code to find numbers in a particular region. Requires a company admin API key. Rate limit: 1200 per minute. Risk: read
Input
Output

office_unassign_number.post

numbers.office_unassign_number.post Dialpad Number — Unassign. Un-assigns a phone number from a office mainline. The number will be returned to the company’s reserved pool if there is one. Otherwise the number will be released. Rate limit: 1200 per minute. Risk: destructive
Input
Output

room_unassign_number.post

numbers.room_unassign_number.post Dialpad Number — Unassign. Un-assigns a phone number from a room. The number will be returned to the company’s reserved pool if there is one. Otherwise the number will be released. Rate limit: 1200 per minute. Risk: destructive
Input
Output

swap

numbers.swap Dialpad Number — Swap. Replaces a target’s primary phone number with a different one and returns the new number. The old number is released. How the replacement is chosen depends on swap_details: give a specific number to swap to that number (it must already be in the company’s reserved pool, and the company must have the reserved_pool experiment enabled), give an area code to take an available number from that area code, or omit swap_details to have one chosen automatically from the reserved pool, falling back to the target’s office area code. Rate limit: 1200 per minute. Risk: destructive
Input
Output

unassign

numbers.unassign Dialpad Number — Unassign. Un-assigns a phone number from its target. This does not delete the number: it returns to the company’s reserved pool if one exists, and can be reassigned later. Pass “release” to give the number up entirely instead, which cannot be undone. Rate limit: 1200 per minute. Risk: destructive
Input
Output

Office Plan

get

office_plan.get Billing Plan — Get. Gets an office’s billing plan: how many licenses of each line type the office has purchased, its remaining calling-credit balance, and the start of the next billing cycle. This reports licenses that are paid for, not how many are free to assign. Rate limit: 1200 per minute. Risk: read
Input
Output

Offices

create

offices.create Office — Create. Creates a secondary office. This provisions a billed entity: currency, plan period and a billing address are all required, and the new office counts against the company’s office limit. There is no corresponding delete endpoint, so an office created here can only be removed by support. Rate limit: 1200 per minute. Risk: destructive
Input
Output

e911.get

offices.e911.get E911 Address — Get. Gets E911 address of the office by office id. Rate limit: 1200 per minute. Risk: read
Input
Output

e911.update

offices.e911.update E911 Address — Update. Update E911 address of the given office. Rate limit: 1200 per minute. Risk: write
Input
Output

get

offices.get Office — Get. Gets an office by id. Rate limit: 1200 per minute. Risk: read
Input
Output

list

offices.list Office — List. Gets the offices in the company. The result set depends on the caller: company admins get every office, while a user-level key gets only the offices that user belongs to. Rate limit: 1200 per minute. Risk: read
Input
Output

offdutystatuses.get

offices.offdutystatuses.get Off-Duty Status — List. Lists Off-Duty status values. Rate limit: 1200 per minute. Risk: read
Input
Output

operators.delete

offices.operators.delete Operator — Remove. Removes an operator from office’s mainline. Rate limit: 1200 per minute. Risk: destructive
Input
Output

operators.get

offices.operators.get Operator — List. Gets mainline operators for an office. Rate limit: 1200 per minute. Risk: read
Input
Output

operators.post

offices.operators.post Operator — Add. Adds an operator into office’s mainline. Rate limit: 1200 per minute. Risk: write
Input
Output

primary.get

offices.primary.get Office — Get Primary. Gets the primary office for the company. Rate limit: 1200 per minute. Risk: read
Input: empty object Output

update

offices.update Office — Update. Updates an office’s business hours. Only the hours-of-operation fields listed below can be changed here — name, billing and routing settings are not editable through this endpoint. Rate limit: 1200 per minute. Risk: write
Input
Output

Phone Number

format

phone_number.format Phone String — Reformat. Converts a phone number between local and E.164 format. Returns the E.164 number, the formatted local number, the area code, and the ISO country code. Rate limit: 1200 per minute. Risk: write
Input
Output

Powerdialer

bulkUpdateLeadItems

powerdialer.bulkUpdateLeadItems Bulk update LeadListItems. Update multiple LeadListItems in a single operation. Only updates items in ‘pending’ state. Risk: write
Input
Output

createApiKey

powerdialer.createApiKey Create API Key. Issue a key acting as the caller, or as a service account (admins only). This is the only response that ever includes the secret, as token_full - store it Risk: write
Input
Output

createAudience

powerdialer.createAudience Create an Audience. Create an Audience Risk: write
Input
Output

createBot

powerdialer.createBot Create Bot. Create a new Bot representing a kare widget Risk: write
Input
Output

createBotDialog

powerdialer.createBotDialog Create Bot Dialog. Create a pending BotDialog and start the dialog job: init a kare converse conversation, connect its websocket, and send text as the first message Risk: write
Input
Output

createBotMessage

powerdialer.createBotMessage Create Bot Message. Queue a new user message on an open BotDialog. The dialog job sends pending messages into the socket and marks them sent. Risk: write
Input
Output

createCampaign

powerdialer.createCampaign Create Campaign. Create a new Campaign associated with a Dialpad Target Risk: write
Input
Output

createCampaignGroup

powerdialer.createCampaignGroup Create Campaign Group. Create Campaign Group Risk: write
Input
Output

createCustomProperties

powerdialer.createCustomProperties Create or Update Custom Properties. Create or update custom properties in bulk. Uses upsert semantics: if a property with the same name already exists, it will be updated with the new values. Otherwise, a new property will be created. Property names must contain only alphanumeric characters and underscores. Risk: write
Input
Output: object[]

createLeadList

powerdialer.createLeadList Create a shared LeadList. Create a new shared LeadList Risk: write
Input
Output

createLeads

powerdialer.createLeads Create Lead. Create a Lead, and optionally add it to a campaign Risk: write
Input
Output

createPhone

powerdialer.createPhone Create a Phone. Create a Phone entry to the company DNC/DNT table Risk: write
Input
Output

createRule

powerdialer.createRule Create rule for a campaign. Create a rule for a campaign Risk: write
Input
Output

createSalesforceListViewImport

powerdialer.createSalesforceListViewImport Import Salesforce ListView records into Leads. Import a Salesforce list view into Dialbunny database Risk: write
Input
Output

createSalesforceObjectMapping

powerdialer.createSalesforceObjectMapping Create Salesforce Object Mapping. Create a new Salesforce object mapping for the company or a specific campaign Risk: write
Input
Output

createServiceAccount

powerdialer.createServiceAccount Create Service Account. Create a service account with a role (‘admin’ or ‘read_only’). Company admins only Risk: write
Input
Output

createStaticList

powerdialer.createStaticList Create a Static List. Create a Static List Risk: write
Input
Output

deleteApiKey

powerdialer.deleteApiKey Delete API Key. Revoke a key Risk: destructive
Input
Output: any

deleteAudience

powerdialer.deleteAudience Delete an Audience. Delete a Audience Risk: destructive
Input
Output: any

deleteBot

powerdialer.deleteBot Delete Bot. Delete a Bot Risk: destructive
Input
Output: any

deleteBotDialog

powerdialer.deleteBotDialog Delete Bot Dialog. Delete a BotDialog and all of its messages Risk: destructive
Input
Output: any

deleteBotMessage

powerdialer.deleteBotMessage Delete Bot Message. Delete a BotMessage Risk: destructive
Input
Output: any

deleteCampaign

powerdialer.deleteCampaign Delete Campaign. Delete a campaign entity Risk: destructive
Input
Output: any

deleteCampaignGroup

powerdialer.deleteCampaignGroup Delete Campaign Group, unlink member campaigns. Delete Campaign Group, unlink member campaigns Risk: destructive
Input
Output: any

deleteCsv

powerdialer.deleteCsv Delete CSV. Delete a Csv Entity Risk: destructive
Input
Output: any

deleteCustomProperty

powerdialer.deleteCustomProperty Delete Custom Property. Delete a custom property Risk: destructive
Input
Output: any

deleteLeadList

powerdialer.deleteLeadList Delete a LeadList. Delete a shared LeadList and its associated Audiences and StaticLists Risk: destructive
Input
Output: any

deleteLeadListItem

powerdialer.deleteLeadListItem Delete a LeadListItem. Delete a LeadListItem Risk: destructive
Input
Output: any

deleteModelsByKeysOfKind

powerdialer.deleteModelsByKeysOfKind Bulk delete entities of a single kind by short keys. Bulk delete entities of a single kind by a list of ids or short keys Risk: destructive
Input
Output: any

deletePhone

powerdialer.deletePhone Soft Delete Phone. Soft Delete a Phone Entity Risk: destructive
Input
Output

deletePhoneCsv

powerdialer.deletePhoneCsv Delete Phone CSV. Delete a Phone Csv Entity Risk: destructive
Input
Output: any

deleteRule

powerdialer.deleteRule Delete a rule. Delete a rule belonging to a campaign with campaign_id Risk: destructive
Input
Output: any

deleteSalesforceObjectMapping

powerdialer.deleteSalesforceObjectMapping Delete Salesforce Object Mapping. Delete a Salesforce object mapping Risk: destructive
Input
Output: empty object

deleteServiceAccount

powerdialer.deleteServiceAccount Delete Service Account. Delete a service account and revoke every key issued for it. The company’s default account cannot be deleted. Company admins only Risk: destructive
Input
Output: any

deleteStaticList

powerdialer.deleteStaticList Delete a Static List. Delete a Static List Risk: destructive
Input
Output: any

duplicateAudience

powerdialer.duplicateAudience Duplicate an Audience. Create a new audience from an existing one Risk: write
Input
Output

duplicateCampaign

powerdialer.duplicateCampaign Duplicate a Campaign. Create a new campaign from an existing one Risk: write
Input
Output

duplicateLeadList

powerdialer.duplicateLeadList Duplicate a LeadList. Create a new shared LeadList from an existing one, including duplicating its Audiences and StaticLists Risk: write
Input
Output

duplicateStaticList

powerdialer.duplicateStaticList Duplicate a Static List. Create a new static list from an existing one Risk: write
Input
Output

editCampaignSettings

powerdialer.editCampaignSettings Edit Settings for a Campaign. Edit a Campaign Settings object Risk: write
Input
Output

getAblyToken

powerdialer.getAblyToken Ably Auth Endpoint. Auth endpoint for ably js client Risk: read
Input: empty object Output

getApiKey

powerdialer.getApiKey Get API Key. Get a key by its id (the token’s hash). The token itself is not returned Risk: read
Input
Output

getApiKeys

powerdialer.getApiKeys List API Keys. List the keys issued for the company. Tokens are never returned - each key is identified by id (the token’s hash) and token is its tail. Admins see every key, everyone else only keys acting as themselves Risk: read
Input
Output: object[]

getAudience

powerdialer.getAudience Get Audience. Get a single Audience by id Risk: read
Input
Output

getAudiences

powerdialer.getAudiences Get Audiences. Get a list of Audiences Risk: read
Input
Output: object[]

getBot

powerdialer.getBot Get Bot. Get a single Bot by ID Risk: read
Input
Output

getBotDialog

powerdialer.getBotDialog Get Bot Dialog. Get a single BotDialog by ID Risk: read
Input
Output

getBotDialogs

powerdialer.getBotDialogs List Bot Dialogs. Get all BotDialogs for the company, optionally filtered by bot_id Risk: read
Input
Output: object[]

getBotMessage

powerdialer.getBotMessage Get Bot Message. Get a single BotMessage by ID Risk: read
Input
Output

getBotMessages

powerdialer.getBotMessages List Bot Messages. Get the transcript of a BotDialog, oldest message first Risk: read
Input
Output: object[]

getBots

powerdialer.getBots List Bots. Get all Bots (kare widgets) for the company Risk: read
Input
Output: object[]

getCampaign

powerdialer.getCampaign Get Campaign. Get an individual Campaign Risk: read
Input
Output

getCampaignGroup

powerdialer.getCampaignGroup Get A Campaign Group. Get A Campaign Group Risk: read
Input
Output

getCampaignGroups

powerdialer.getCampaignGroups List Campaign Groups. List Campaign Groups Risk: read
Input
Output: object[]

getCampaignResultExportUrl

powerdialer.getCampaignResultExportUrl Get campaign result export url. Get a presigned url to download campaign result export Risk: read
Input
Output

getCampaigns

powerdialer.getCampaigns List of Campaigns. Fetch a list of Campaign entities assoicated with the company Risk: read
Input
Output: object[]

getCampaignSettings

powerdialer.getCampaignSettings Get a Campaign Settings object. Settings for a Campaign Risk: read
Input
Output

getContact

powerdialer.getContact Get a Contact. Get a Contact Risk: read
Input
Output

getCsv

powerdialer.getCsv Get CSV. Get an individual CSV entity Risk: read
Input
Output

getCsvPresignedUrl

powerdialer.getCsvPresignedUrl Generate a presigned url to download a CSV file with TTL=30s. Generate a presigned url to download a CSV file with TTL=30s Risk: read
Input
Output

getCsvs

powerdialer.getCsvs Get List of CSVs. Get a list of Csv entities Risk: read
Input
Output: object[]

getCurrentUser

powerdialer.getCurrentUser The Current User. JSON representation of the logged in user Risk: read
Input: empty object Output

getCustomProperties

powerdialer.getCustomProperties List Custom Properties. Get a list of custom properties for the company Risk: read
Input
Output: object[]

getCustomProperty

powerdialer.getCustomProperty Get Custom Property. Get a single custom property by id Risk: read
Input
Output

getDialpadOAuthService

powerdialer.getDialpadOAuthService Get Dialpad OAuth Service. Get a Dialpad OAuth Service record by service name Risk: read
Input
Output

getEventLogs

powerdialer.getEventLogs Get EventLogs. Get a list of EventLog’s for a Campaign Risk: read
Input
Output: object[]

getGlobalSettings

powerdialer.getGlobalSettings Get Company GlobalSettings. Get company GlobalSettings with only modified fields Risk: read
Input
Output

getJob

powerdialer.getJob Get Job. Get a single Job by ID, including its reduced results Risk: read
Input
Output

getJobs

powerdialer.getJobs List Jobs. Get all background Jobs for the company, newest first Risk: read
Input
Output: object[]

getLead

powerdialer.getLead Get Lead. Get an individual lead Risk: read
Input
Output

getLeadCompanies

powerdialer.getLeadCompanies List of LeadCompanies. Get a list of LeadCompany entities, with optional search and ordering Risk: read
Input
Output: object[]

getLeadCompany

powerdialer.getLeadCompany Get LeadCompany. Get an individual LeadCompany Risk: read
Input
Output

getLeadExport

powerdialer.getLeadExport Get a Lead CSV export. Poll an export started with POST /api/lead_export. While it is still running there is no ‘url’; on success ‘url’ is a short-lived signed download link; on failure ‘error’ says why. Risk: read
Input
Output

getLeadItem

powerdialer.getLeadItem Get LeadItem. Get a LeadItem Risk: read
Input
Output

getLeadItems

powerdialer.getLeadItems List of LeadListItem + Lead. A mashup api to return a sortable, searchable list for campaign details Risk: read
Input
Output: object[]

getLeadListItem

powerdialer.getLeadListItem Get a LeadListItem. Get a single LeadListItem by id Risk: read
Input
Output

getLeadLists

powerdialer.getLeadLists List of LeadList. Get a list of LeadLists Risk: read
Input
Output: object[]

getLeadListView

powerdialer.getLeadListView Search shared LeadLists. Search shared LeadLists with optional campaign counts Risk: read
Input
Output: object[]

getLeadListViewById

powerdialer.getLeadListViewById Get a LeadList view. Get a single LeadList with optional campaign counts Risk: read
Input
Output

getLeads

powerdialer.getLeads List of Leads. Get a list of Leads, including searching for leads by filter, sql, and ai Risk: read
Input
Output: object[]

getListItems

powerdialer.getListItems List of LeadListItem. List of LeadListItem belonging to a Campaign Risk: read
Input
Output: object[]

getListList

powerdialer.getListList Get a LeadList. Get a LeadList Risk: read
Input
Output

getListView

powerdialer.getListView Get Combined List View. Get a combined list of Csv, Audience, and StaticList entities Risk: read
Input
Output: object[]

getLogin

powerdialer.getLogin Initial endpoint to hit after oauth. Returns all initial values for user, company, config, etc Risk: read
Input: empty object Output

getModelsByKeys

powerdialer.getModelsByKeys Bulk fetch entities by short keys. Bulk fetch entity short keys by comma-delimited url params Risk: read
Input
Output: object[]

getModelsByKeysOfKind

powerdialer.getModelsByKeysOfKind Bulk fetch entities of a single kind by short keys. Bulk fetch entities of a single kind by a list of ids or short keys Risk: read
Input
Output: object[]

getOperator

powerdialer.getOperator Get Operator. Get a list of Operators Risk: read
Input
Output: object[]

getPhone

powerdialer.getPhone Get Phone. Get an individual Phone entity Risk: read
Input
Output

getPhoneCsv

powerdialer.getPhoneCsv Get Phone CSV. Get an individual Phone CSV entity Risk: read
Input
Output

getPhoneCsvs

powerdialer.getPhoneCsvs Get List of Phone CSVs. Get a list of PhoneCsv entities Risk: read
Input
Output: object[]

getPhones

powerdialer.getPhones List of Phones. Get a list of phone table for company DNC/DNT Risk: read
Input
Output: object[]

getRule

powerdialer.getRule Get Rule. Get a Rule Risk: read
Input
Output

getRules

powerdialer.getRules List of rules for a campaign. List of rules belonging to a campaign with campaign id Risk: read
Input
Output: object[]

getSalesforceListViewById

powerdialer.getSalesforceListViewById Get Salesforce List View by ID. Retrieve a specific list view from Dialbunny database Risk: read
Input
Output

getSalesforceListViewImport

powerdialer.getSalesforceListViewImport Get Salesforce ListView Import. Get a Salesforce ListView Import record by ID Risk: read
Input
Output

getSalesforceListViewImports

powerdialer.getSalesforceListViewImports List Salesforce ListView Imports. Get all Salesforce ListView Import records for a campaign Risk: read
Input
Output: object[]

getSalesforceObjectFields

powerdialer.getSalesforceObjectFields Get Object Fields from Salesforce. Fetch field metadata for a Salesforce object via sObject Describe API Risk: read
Input
Output: object[]

getSalesforceObjectListViews

powerdialer.getSalesforceObjectListViews Get List Views from Salesforce. Fetch list views from Salesforce Risk: read
Input
Output: object[]

getSalesforceObjectMapping

powerdialer.getSalesforceObjectMapping Get Salesforce Object Mapping. Get a specific Salesforce object mapping by ID Risk: read
Input
Output

getSalesforceObjectMappings

powerdialer.getSalesforceObjectMappings List Salesforce Object Mappings. Get all Salesforce object mappings for the company, optionally filtered by campaign or sobject type Risk: read
Input
Output: object[]

getServiceAccount

powerdialer.getServiceAccount Get Service Account. Get a single service account by id Risk: read
Input
Output

getServiceAccounts

powerdialer.getServiceAccounts List Service Accounts. Get the company’s service accounts - non-human principals that api keys can be issued for and that author the entities they create Risk: read
Input
Output: object[]

getSmsForTarget

powerdialer.getSmsForTarget Get Sms List for a Target. DEBUG: Get a list of recent sms given a Target Risk: read
Input
Output: object[]

getStaticList

powerdialer.getStaticList Get Static List. Get a single Static List by id Risk: read
Input
Output

getStaticLists

powerdialer.getStaticLists Get Static Lists. Get a list of Static Lists Risk: read
Input
Output: object[]

getVarsInfo

powerdialer.getVarsInfo Get auto-complete variable info. Auto-complete variable info belonging to a campaign with campaign id Risk: read
Input
Output: any

getWorker

powerdialer.getWorker Get a Worker. Get a Worker Risk: read
Input
Output

getWorkers

powerdialer.getWorkers Get Workers. Get a list of Workers for a Campaign Risk: read
Input
Output: object[]

patchSalesforceListView

powerdialer.patchSalesforceListView Update Salesforce List View. Perform actions on a Salesforce list view (e.g. refresh_count) Risk: write
Input
Output

postLogin

powerdialer.postLogin Login with a Dialpad access token. Establishes a browser session from a Dialpad access token bearer: sets the session cookie and returns the login json (Dialpad’s raw payload with raw=1) Risk: write
Input
Output

queryLeads

powerdialer.queryLeads List of Leads by Query. Get a list of Leads based on complex Queries Risk: write
Input
Output: object[]

searchCampaigns

powerdialer.searchCampaigns Search Campaigns with POST. POST version of /api/campaign - supports large lists and date range filtering Risk: write
Input
Output: object[]

smsItem

powerdialer.smsItem Send SMS. DEBUG: Send a text message through dialpad for a given LeadListItem Risk: destructive
Input
Output

startCampaignResultExport

powerdialer.startCampaignResultExport Start a campaign result export job. Start a campaign result export job Risk: write
Input
Output: empty object

startLeadExport

powerdialer.startLeadExport Start a Lead CSV export. Start a CSV export of this company’s Leads and return the export record. The export runs in the background: a BigQuery query job plus an extract job routinely takes longer than a request can wait. Poll GET /api/lead_export/<id> until it returns a ‘url’. Rows are read from the BigQuery mirror of Spanner, which lags writes, so a Lead created moments ago may not be included — narrow with ‘since’ and treat freshness as best-effort. Columns are the standard Lead fields plus every property registered via /api/custom_property. Risk: write
Input
Output

updateApiKey

powerdialer.updateApiKey Update API Key. Rename a key Risk: write
Input
Output

updateAudience

powerdialer.updateAudience Update an Audience. Update an Audience name and/or query Risk: write
Input
Output

updateBot

powerdialer.updateBot Update Bot. Update a Bot’s name or kare ids Risk: write
Input
Output

updateBotDialog

powerdialer.updateBotDialog Update Bot Dialog. Perform an action on a BotDialog, e.g. end it without deleting Risk: write
Input
Output

updateCampaign

powerdialer.updateCampaign Update Campaign. Update a Campaign like starting, resetting, etc Risk: destructive
Input
Output

updateCampaignGroup

powerdialer.updateCampaignGroup Update Campaign Group. Update Campaign Group Risk: write
Input
Output

updateCsv

powerdialer.updateCsv Update CSV. Update a CSV with a mapping, labels, name, etc Risk: write
Input
Output

updateCustomProperty

powerdialer.updateCustomProperty Update Custom Property. Update a custom property Risk: write
Input
Output

updateGlobalSettings

powerdialer.updateGlobalSettings Update Company GlobalSettings. Update company GlobalSettings entity Risk: write
Input
Output

updateLead

powerdialer.updateLead Update Lead. Update a Lead Risk: write
Input
Output

updateLeadItem

powerdialer.updateLeadItem Update LeadItem. Update a LeadItem Risk: write
Input
Output

updateLeadList

powerdialer.updateLeadList Update LeadList. Update a LeadList with csv_ids, audience_ids, etc. Supports actions: set_audience, remove_audience, create_static_list, add_leads, remove_leads, add_snapshot, refresh_snapshot, clear_snapshot, clear_manual, refresh_audience Risk: write
Input
Output

updatePhone

powerdialer.updatePhone Update Phone. Update a Phone DNC/DNT statuses Risk: write
Input
Output

updatePhoneCsv

powerdialer.updatePhoneCsv Update Phone CSV. Update a Phone CSV with a mapping, labels, name, etc Risk: write
Input
Output

updateRule

powerdialer.updateRule Update a rule for a campaign. Update a rule for a campaign Risk: write
Input
Output

updateSalesforceListViewImport

powerdialer.updateSalesforceListViewImport Update Salesforce ListView Import. Update a Salesforce ListView Import, e.g., start the import job Risk: write
Input
Output

updateSalesforceObjectMapping

powerdialer.updateSalesforceObjectMapping Update Salesforce Object Mapping. Update an existing Salesforce object mapping Risk: write
Input
Output

updateServiceAccount

powerdialer.updateServiceAccount Update Service Account. Rename a service account or change its role. Company admins only Risk: write
Input
Output

updateStaticList

powerdialer.updateStaticList Update Static List. Update a Static List with leads Risk: write
Input
Output

updateWorker

powerdialer.updateWorker Update Worker. Update a Worker Risk: write
Input
Output

create

recording_share_link.create Recording Sharelink — Create. Creates a recording share link. Rate limit: 100 per minute. Risk: write
Input
Output

delete

recording_share_link.delete Recording Sharelink — Delete. Deletes a recording share link by id. Rate limit: 1200 per minute. Risk: destructive
Input
Output

get

recording_share_link.get Recording Sharelink — Get. Gets a recording share link by id. Rate limit: 1200 per minute. Risk: read
Input
Output

update

recording_share_link.update Recording Sharelink — Update. Updates a recording share link by id. Rate limit: 100 per minute. Risk: write
Input
Output

Recordings

admin_call.download

recordings.admin_call.download Admin Call Recording — Download. Downloads an admin recording through its share-link ID as a bounded base64 result. Risk: read
Input Admin recordings cannot be downloaded from their browser-only URL. Create a recording share link first and pass its ID here; the plugin returns the bytes in the bounded base64 result envelope.
Output

call.download

recordings.call.download Call Recording — Download. Downloads completed call audio as a bounded base64 result; requires recordings_export scope. Risk: read
Input Requires the recordings_export scope. The guide documents successful downloads as audio/mpeg; the plugin returns the raw bytes in the same bounded base64 result envelope as report downloads.
Output

voicemail.download

recordings.voicemail.download Voicemail Recording — Download. Downloads voicemail audio as a bounded base64 result; requires recordings_export scope. Risk: read
Input Requires the recordings_export scope. The guide documents successful downloads as audio/mpeg; the plugin returns the raw bytes in the same bounded base64 result envelope as report downloads.
Output

Reports

scheduledstats.download

reports.scheduledstats.download Report Download API — Download scheduled stats. Downloads the requested scheduled report when available. The official page documents the report type user_voiceline and a YYYY-MM-DD date, but does not publish a success content type or response schema; the plugin returns the report bytes in a validated base64 envelope. Risk: read
Input The official Report Download API page does not specify the successful response media type or maximum report size. The plugin returns bytes as { kind: 'binary', contentType, base64, sizeBytes }, with a 25 MiB client safety cap and 20-second timeout. The t field currently accepts the only documented report type, user_voiceline.
Output

Rooms

delete

rooms.delete Room — Delete. Deletes a room by id. Rate limit: 1200 per minute. Risk: destructive
Input
Output

get

rooms.get Room — Get. Gets a room by id. Rate limit: 1200 per minute. Risk: read
Input
Output

list

rooms.list Room — List. Gets all rooms in your company, optionally filtering by office. Rate limit: 1200 per minute. Risk: read
Input
Output

patch

rooms.patch Room — Update. Updates room details by id. Rate limit: 1200 per minute. Risk: write
Input
Output

post

rooms.post Room — Create. Creates a new room. Rate limit: 1200 per minute. Risk: write
Input
Output

Schedule Reports

create

schedule_reports.create schedule reports — Create. Creates a schedule reports subscription for your company. An endpoint_id is required in order to receive the event payload and can be obtained via websockets or webhooks. A schedule reports is a mechanism to schedule daily, weekly or monthly record and statistics reports. Rate limit: 1200 per minute. Risk: write
Input
Output

delete

schedule_reports.delete Schedule reports — Delete. Deletes a schedule report subscription by id. A schedule report is a mechanism to schedule daily, weekly or monthly record and statistics reports. Rate limit: 1200 per minute. Risk: destructive
Input
Output

get

schedule_reports.get Schedule reports — Get. Gets a schedule report subscription by id. A schedule report is a mechanism to schedule daily, weekly or monthly record and statistics reports. Rate limit: 1200 per minute. Risk: read
Input
Output

list

schedule_reports.list Schedule reports — List. Lists all schedule reports subscription for a company. A schedule report is a mechanism to schedule daily, weekly or monthly record and statistics reports. Rate limit: 1200 per minute. Risk: read
Input
Output

update

schedule_reports.update Schedule reports — Update. Updates a schedule report subscription by id. A schedule report is a mechanism to schedule daily, weekly or monthly record and statistics reports. Rate limit: 1200 per minute. Risk: write
Input
Output

Scheduled Messages

create

scheduled_messages.create Schedule — Create. Creates a new scheduled message that will be sent at the specified time. Messages can be sent to multiple phone numbers OR to a Dialpad channel. Supports both SMS (text only) and MMS (text with media attachments). Rate limit: 1200 per minute. Risk: destructive
Input
Output

delete

scheduled_messages.delete Schedule — Delete. Deletes (cancels) a scheduled message. The message will not be sent. Rate limit: 1200 per minute. Risk: destructive
Input
Output

get

scheduled_messages.get Schedule — Get. Gets a single scheduled message by ID. Rate limit: 1200 per minute. Risk: read
Input
Output

list

scheduled_messages.list Schedule — List. Lists all active scheduled messages for the authenticated user. Only active (pending) schedules are returned. Deleted or sent schedules are not included. Results can be paginated using the cursor parameter. Rate limit: 1200 per minute. Risk: read
Input
Output

send_now

scheduled_messages.send_now Schedule — Send Now. Immediately sends a scheduled message and deletes the schedule. This is useful for testing or when you want to send a scheduled message before its scheduled time. Rate limit: 1200 per minute. Risk: destructive
Input
Output

update

scheduled_messages.update Schedule — Update. Updates an existing scheduled message. Supports partial updates. Only the fields provided in the request will be updated. Fields not provided will retain their existing values. This follows PATCH semantics. Rate limit: 1200 per minute. Risk: write
Input
Output

Scorecards

export.create

scorecards.export.create Scorecards export — Initiate Processing. Begins processing a scorecards export asynchronously, returning a request id to get the status and retrieve the results by calling GET /scorecards/export/{request_id}. Scorecards for the whole company will be processed by default. A target_id and target_type can be provided to limit the export to a single target. Rate limit: 250 per minute. Risk: write
Input
Output

export.get

scorecards.export.get Scorecards export — Get Result. Gets the progress and result of a scorecards report request. Rate limit: 1200 per minute. Risk: read
Input
Output

get

scorecards.get Scorecards — Get. Gets a scorecard by id. Rate limit: 1200 per minute. Risk: read
Input
Output

list

scorecards.list Scorecards — List. Gets a list of scorecards of a target. Rate limit: 1200 per minute. Risk: read
Input
Output

Screen Pop

initiate

screen_pop.initiate Screen-pop — Trigger. Opens the given URI on the user’s active Dialpad device, so an agent sees the relevant record (CRM contact, ticket, order) without searching for it. Returns the device the pop was delivered to. Requires the screen_pop OAuth scope. Requires scope: screen_pop Rate limit: 5 per minute. Risk: write
Input
Output

Search

users

search.users User — Search. Searches for users matching a specific criteria. It matches phone numbers, emails, or name. Optionally, it accepts filters to reduce the amount of final results. - The cursor value is provided in the response, and can be passed as a parameter to retrieve subsequent pages of results. Rate limit: 1200 per minute. Risk: read
Input
Output

Sms

send

sms.send SMS — Send. Sends an SMS message to a phone number or to a Dialpad channel on behalf of a user. Provide either to_numbers or channel_hashtag as the recipient, and either text or media as the content. A channel’s hashtag is available from the channel endpoints. Tier 0 Rate limit: 100 per minute. Tier 1 Rate limit: 800 per minute. Risk: destructive
Input
Output

Stats

export.create

stats.export.create Stats — Initiate Processing. Begins processing statistics asynchronously, returning a request id to get the status and retrieve the results by calling GET /stats/{request_id}. Stats for the whole company will be processed by default. An office_id can be provided to limit stats to a single office. A target_id and target_type can be provided to limit stats to a single target. Rate limit: 200 per hour. Risk: write
Input
Output

export.get

stats.export.get Stats — Get Result. Gets the progress and result of a statistics request. Rate limit: 1200 per minute. Risk: read
Input
Output

Transcripts

get

transcripts.get Call Transcript — Get. Gets the Dialpad AI transcript of a call, including moments. Rate limit: 1200 per minute. Risk: read
Input
Output

get_url

transcripts.get_url Call Transcript — Get URL. Gets the transcript url of a call. Rate limit: 1200 per minute. Risk: read
Input
Output

Userdevices

get

userdevices.get User Device — Get. Get details of a specific device including its type, display name, phone number, and registration dates. Rate limit: 1200 per minute. Risk: read
Input
Output

list

userdevices.list User Device — List. List registered devices for a user, including desk phones, softphones, and mobile apps. Returns device type, display name, phone number, and registration dates. Rate limit: 1200 per minute. Risk: read
Input
Output

Users

assign_number

users.assign_number Dialpad Number — Assign. Assigns a number to a user. The number will automatically be taken from the company’s reserved block if there are reserved numbers, otherwise a number will be auto-assigned from the provided area code. Rate limit: 1200 per minute. Risk: destructive
Input
Output

create

users.create User — Create. Creates a new user. Rate limit: 1200 per minute. Risk: destructive
Input
Output

create_batch

users.create_batch User — Create Batch. Creates up to 25 users in one call, for example to invite a team. Each user is created independently with the same rules as creating a single user, so a failure does not undo the users that were created before it. The response has one result per requested user, in the order sent, with either the created user or the reason it was not created. The reason code no_seats_available means the office has no free license of the type the user would consume. An unexpected server error ends the whole call with a 503 and no per-user results, and the users created before it stay created. Rate limit: 1200 per minute. Risk: destructive
Input
Output

delete

users.delete User — Delete. Deletes a user by id. Rate limit: 1200 per minute. Risk: destructive
Input
Output

e911.get

users.e911.get E911 Address — Get. Gets E911 address of the user by user id. Rate limit: 1200 per minute. Risk: read
Input
Output

e911.update

users.e911.update E911 Address — Update. Update E911 address of the given user. Rate limit: 1200 per minute. Risk: write
Input
Output

get

users.get User — Get. Get a user by id. Returns identity (name, email, job_title), contact details (phone_numbers, extension), status (state, do_not_disturb, is_on_duty, on_duty_status), license type, office membership (office_id, group_details), and voicemail settings. Rate limit: 1200 per minute. Risk: read
Input
Output

initiate_call

users.initiate_call Call — Initiate. Causes a user’s Dialpad application to initiate an outbound call. Note that the user must have at least one active autocallable device (the web or desktop Dialpad app, or a CTI application). The Dialpad mobile apps and physical deskphones do not support this API call. Rate limit: 5 per minute. Risk: destructive
Input
Output

list

users.list User — List. Gets company users, optionally filtering by email. NOTE: The limit parameter has been soft-deprecated. Please omit the limit parameter, or reduce it to 100 or less. - Limit values of greater than 100 will only produce a page size of 100, and a 400 Bad Request response will be produced 20% of the time in an effort to raise visibility of side-effects that might otherwise go un-noticed by solutions that had assumed a larger page size. - The cursor value is provided in the response, and can be passed as a parameter to retrieve subsequent pages of results. Rate limit: 1200 per minute. Risk: read
Input
Output

list_personas

users.list_personas Persona — List. Provides a list of personas for a user. A persona is a target that a user can make calls from. The receiver of the call will see the details of the persona rather than the user. Rate limit: 1200 per minute. Risk: read
Input
Output

move_office

users.move_office User — Switch Office. Moves the user to a different office. For international offices only, all of the user’s numbers will be unassigned and a new number will be assigned except when the user only has internal numbers starting with 803 — then the numbers will remain unchanged. Admin can also assign numbers via the user assign number API after. Only supported on paid accounts and there must be enough licenses to transfer the user to the destination office. Rate limit: 1200 per minute. Risk: destructive
Input
Output

set_caller_id

users.set_caller_id Caller ID — Set. Set Caller ID for a given user ID. Rate limit: 1200 per minute. Risk: write
Input
Output

toggle_call_recording

users.toggle_call_recording Call Recording — Toggle. Turns call recording on or off for a user’s active call. Rate limit: 1200 per minute. Risk: write
Input
Output

toggle_call_vi

users.toggle_call_vi Call VI — Toggle. Turns Voice Intelligence (live transcription and real-time assist) on or off for the user’s currently active call, optionally setting the transcription locale. Fails if the user has no active call. Reversible by calling again. Rate limit: 1200 per minute. Risk: write
Input
Output

toggle_dnd

users.toggle_dnd Do Not Disturb — Toggle. Toggle DND status on or off for the given user. Rate limit: 1200 per minute. Risk: write
Input
Output

unassign_number

users.unassign_number Dialpad Number — Unassign. Un-assigns a phone number from a user. The number will be returned to the company’s reserved block if there is one. Otherwise the number will be released. Rate limit: 1200 per minute. Risk: destructive
Input
Output

update

users.update User — Update. Updates the provided fields for an existing user. Rate limit: 1200 per minute. Risk: write
Input
Output

update_status

users.update_status User Status — Update. Update user’s status. Returns the user’s status if the user exists. Rate limit: 1200 per minute. Risk: write
Input
Output

Websockets

create

websockets.create Websocket — Create. Creates a new websocket for your company. A unique websocket ID will be generated when successfully creating a websocket. A websocket ID is to be required when creating event subscriptions. One websocket ID can be shared between multiple event subscriptions. When triggered, events will be accessed through provided websocket_url under websocket. The url will be expired after 1 hour. Please use the GET websocket API to regenerate url rather than creating new ones. If a secret is provided, the websocket events will be encoded and signed in the JWT format using the shared secret with the HS256 algorithm. The JWT payload should be decoded and the signature verified to ensure that the event came from Dialpad. If no secret is provided, unencoded events will be sent in the JSON format. It is recom Risk: write
Input
Output

delete

websockets.delete Websocket — Delete. Deletes a websocket by id. Rate limit: 1200 per minute. Risk: destructive
Input
Output

get

websockets.get Websocket — Get. Gets a websocket by id. Rate limit: 1200 per minute. Risk: read
Input
Output

list

websockets.list Websocket — List. Gets a list of all the websockets that are associated with the company. Rate limit: 1200 per minute. Risk: read
Input
Output

update

websockets.update Websocket — Update. Updates a websocket by id. Rate limit: 1200 per minute. Risk: write
Input
Output

Wfm

wfm-metrics-activity.get

wfm.wfm-metrics-activity.get Activity Metrics. Returns paginated, activity-level metrics for specified agents. Rate limit: 1200 per minute. Risk: read
Input
Output

wfm-metrics-agent.get

wfm.wfm-metrics-agent.get Agent Metrics. Returns paginated, detailed agent-level performance metrics. Rate limit: 1200 per minute. Risk: read
Input
Output