{
  "info": {
    "name": "DCDial API",
    "description": "https://apidocs.dcdial.com/ — run Authentication → Log in, then set the token variable.",
    "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json"
  },
  "variable": [
    {
      "key": "baseUrl",
      "value": "https://api-qa.dcdial.com/api/"
    },
    {
      "key": "token",
      "value": ""
    }
  ],
  "item": [
    {
      "name": "Authentication",
      "item": [
        {
          "name": "Log in",
          "request": {
            "method": "POST",
            "url": "{{baseUrl}}",
            "description": "Exchanges a DCDial username and password for an API token. Send the token as the token field on every other request.\n\nhttps://apidocs.dcdial.com/reference/authentication/login/",
            "body": {
              "mode": "urlencoded",
              "urlencoded": [
                {
                  "key": "type",
                  "value": "login_user",
                  "type": "text"
                },
                {
                  "key": "user",
                  "value": "jane.doe",
                  "type": "text"
                },
                {
                  "key": "pass",
                  "value": "{{token}}",
                  "type": "text"
                }
              ]
            }
          }
        }
      ]
    },
    {
      "name": "Campaigns",
      "item": [
        {
          "name": "Play campaign",
          "request": {
            "method": "POST",
            "url": "{{baseUrl}}",
            "description": "Starts outbound dialing for a campaign. It keeps dialing until you pause or stop it, or until it runs out of accounts to call.\n\nhttps://apidocs.dcdial.com/reference/campaigns/play-campaign/",
            "body": {
              "mode": "urlencoded",
              "urlencoded": [
                {
                  "key": "type",
                  "value": "play_campaign",
                  "type": "text"
                },
                {
                  "key": "token",
                  "value": "{{token}}",
                  "type": "text"
                },
                {
                  "key": "campaign_id",
                  "value": "1024",
                  "type": "text"
                }
              ]
            }
          }
        },
        {
          "name": "Pause campaign",
          "request": {
            "method": "POST",
            "url": "{{baseUrl}}",
            "description": "Suspends outbound dialing for a running campaign. Calls already in progress finish normally.\n\nhttps://apidocs.dcdial.com/reference/campaigns/pause-campaign/",
            "body": {
              "mode": "urlencoded",
              "urlencoded": [
                {
                  "key": "type",
                  "value": "pause_campaign",
                  "type": "text"
                },
                {
                  "key": "token",
                  "value": "{{token}}",
                  "type": "text"
                },
                {
                  "key": "campaign_id",
                  "value": "1024",
                  "type": "text"
                }
              ]
            }
          }
        },
        {
          "name": "Stop campaign",
          "request": {
            "method": "POST",
            "url": "{{baseUrl}}",
            "description": "Stops a running or paused campaign, deactivates it and clears its dialing queue.\n\nhttps://apidocs.dcdial.com/reference/campaigns/stop-campaign/",
            "body": {
              "mode": "urlencoded",
              "urlencoded": [
                {
                  "key": "type",
                  "value": "stop_campaign",
                  "type": "text"
                },
                {
                  "key": "token",
                  "value": "{{token}}",
                  "type": "text"
                },
                {
                  "key": "campaign_id",
                  "value": "1024",
                  "type": "text"
                }
              ]
            }
          }
        },
        {
          "name": "List campaigns",
          "request": {
            "method": "POST",
            "url": "{{baseUrl}}",
            "description": "Lists the campaigns you can access, newest first, with their status.\n\nhttps://apidocs.dcdial.com/reference/campaigns/list-campaigns/",
            "body": {
              "mode": "urlencoded",
              "urlencoded": [
                {
                  "key": "type",
                  "value": "get_campaigns",
                  "type": "text"
                },
                {
                  "key": "token",
                  "value": "{{token}}",
                  "type": "text"
                }
              ]
            }
          }
        },
        {
          "name": "Get campaign settings",
          "request": {
            "method": "POST",
            "url": "{{baseUrl}}",
            "description": "Returns a campaign’s settings (dial method, caller ID, calling hours, answering-machine detection, recording and more), each with its current value and the allowed options.\n\nhttps://apidocs.dcdial.com/reference/campaigns/get-campaign-settings/",
            "body": {
              "mode": "urlencoded",
              "urlencoded": [
                {
                  "key": "type",
                  "value": "get_campaign_settings",
                  "type": "text"
                },
                {
                  "key": "token",
                  "value": "{{token}}",
                  "type": "text"
                },
                {
                  "key": "campaign_id",
                  "value": "1024",
                  "type": "text"
                }
              ]
            }
          }
        },
        {
          "name": "Update campaign",
          "request": {
            "method": "POST",
            "url": "{{baseUrl}}",
            "description": "Changes one or more settings of a campaign. Send only the fields you want to change; get the allowed values from Get campaign settings.\n\nhttps://apidocs.dcdial.com/reference/campaigns/update-campaign/",
            "body": {
              "mode": "urlencoded",
              "urlencoded": [
                {
                  "key": "type",
                  "value": "update_campaign",
                  "type": "text"
                },
                {
                  "key": "token",
                  "value": "{{token}}",
                  "type": "text"
                },
                {
                  "key": "campaign_id",
                  "value": "1024",
                  "type": "text"
                }
              ]
            }
          }
        },
        {
          "name": "Place a test call",
          "request": {
            "method": "POST",
            "url": "{{baseUrl}}",
            "description": "Places a single test call with a campaign’s settings, so you can hear the message and check delivery before any account holders are called.\n\nhttps://apidocs.dcdial.com/reference/campaigns/test-call/",
            "body": {
              "mode": "urlencoded",
              "urlencoded": [
                {
                  "key": "type",
                  "value": "dial_number",
                  "type": "text"
                },
                {
                  "key": "token",
                  "value": "{{token}}",
                  "type": "text"
                },
                {
                  "key": "campaign_id",
                  "value": "1024",
                  "type": "text"
                },
                {
                  "key": "phone_number",
                  "value": "5551234567",
                  "type": "text"
                },
                {
                  "key": "callerid",
                  "value": "5559876543",
                  "type": "text"
                }
              ]
            }
          }
        }
      ]
    },
    {
      "name": "Accounts",
      "item": [
        {
          "name": "Create or update an account",
          "request": {
            "method": "POST",
            "url": "{{baseUrl}}",
            "description": "Creates an account with its phone numbers and email addresses, or updates it if an account with the same accountid already exists.\n\nhttps://apidocs.dcdial.com/reference/accounts/add-account/",
            "body": {
              "mode": "urlencoded",
              "urlencoded": [
                {
                  "key": "type",
                  "value": "add_account",
                  "type": "text"
                },
                {
                  "key": "token",
                  "value": "{{token}}",
                  "type": "text"
                },
                {
                  "key": "account[company_id]",
                  "value": "101",
                  "type": "text"
                },
                {
                  "key": "account[accountid]",
                  "value": "ACC-10045",
                  "type": "text"
                },
                {
                  "key": "account[first_name]",
                  "value": "Jane",
                  "type": "text"
                },
                {
                  "key": "account[last_name]",
                  "value": "Doe",
                  "type": "text"
                },
                {
                  "key": "account[balance]",
                  "value": "1250.5",
                  "type": "text"
                },
                {
                  "key": "accounts_leads[list_id]",
                  "value": "2048",
                  "type": "text"
                },
                {
                  "key": "phones[0][phone_number]",
                  "value": "5550100123",
                  "type": "text"
                },
                {
                  "key": "phones[0][phone_type]",
                  "value": "MOBILE",
                  "type": "text"
                },
                {
                  "key": "emails[0]",
                  "value": "jane@example.com",
                  "type": "text"
                }
              ]
            }
          }
        },
        {
          "name": "Fetch accounts",
          "request": {
            "method": "POST",
            "url": "{{baseUrl}}",
            "description": "Lists the accounts in your company, with either every phone number and email per account or just the primary ones.\n\nhttps://apidocs.dcdial.com/reference/accounts/fetch-accounts/",
            "body": {
              "mode": "urlencoded",
              "urlencoded": [
                {
                  "key": "type",
                  "value": "fetch_accounts",
                  "type": "text"
                },
                {
                  "key": "token",
                  "value": "{{token}}",
                  "type": "text"
                },
                {
                  "key": "company_id",
                  "value": "101",
                  "type": "text"
                }
              ]
            }
          }
        }
      ]
    },
    {
      "name": "Lists",
      "item": [
        {
          "name": "Get list",
          "request": {
            "method": "POST",
            "url": "{{baseUrl}}",
            "description": "Returns one list with its campaign, status, account counts and dialing progress.\n\nhttps://apidocs.dcdial.com/reference/lists/get-list/",
            "body": {
              "mode": "urlencoded",
              "urlencoded": [
                {
                  "key": "type",
                  "value": "get_list",
                  "type": "text"
                },
                {
                  "key": "token",
                  "value": "{{token}}",
                  "type": "text"
                },
                {
                  "key": "list_id",
                  "value": "2048",
                  "type": "text"
                }
              ]
            }
          }
        },
        {
          "name": "List all lists",
          "request": {
            "method": "POST",
            "url": "{{baseUrl}}",
            "description": "Lists your calling lists, newest first. Filter by campaign or status.\n\nhttps://apidocs.dcdial.com/reference/lists/list-lists/",
            "body": {
              "mode": "urlencoded",
              "urlencoded": [
                {
                  "key": "type",
                  "value": "get_lists",
                  "type": "text"
                },
                {
                  "key": "token",
                  "value": "{{token}}",
                  "type": "text"
                },
                {
                  "key": "campaign_id",
                  "value": "1024",
                  "type": "text"
                },
                {
                  "key": "status",
                  "value": "Y",
                  "type": "text"
                },
                {
                  "key": "filter",
                  "value": "RA",
                  "type": "text"
                }
              ]
            }
          }
        },
        {
          "name": "Change list status",
          "request": {
            "method": "POST",
            "url": "{{baseUrl}}",
            "description": "Turns a list on or off for dialing.\n\nhttps://apidocs.dcdial.com/reference/lists/change-list-status/",
            "body": {
              "mode": "urlencoded",
              "urlencoded": [
                {
                  "key": "type",
                  "value": "change_status",
                  "type": "text"
                },
                {
                  "key": "token",
                  "value": "{{token}}",
                  "type": "text"
                },
                {
                  "key": "list_id",
                  "value": "2048",
                  "type": "text"
                },
                {
                  "key": "status",
                  "value": "Y",
                  "type": "text"
                }
              ]
            }
          }
        },
        {
          "name": "Search accounts and call log",
          "request": {
            "method": "POST",
            "url": "{{baseUrl}}",
            "description": "Searches accounts and the call log by phone number, account, name, date and other details.\n\nhttps://apidocs.dcdial.com/reference/lists/search-accounts/",
            "body": {
              "mode": "urlencoded",
              "urlencoded": [
                {
                  "key": "type",
                  "value": "search_lead",
                  "type": "text"
                },
                {
                  "key": "token",
                  "value": "{{token}}",
                  "type": "text"
                },
                {
                  "key": "query",
                  "value": "Doe",
                  "type": "text"
                },
                {
                  "key": "search_date",
                  "value": "value",
                  "type": "text"
                },
                {
                  "key": "from",
                  "value": "value",
                  "type": "text"
                }
              ]
            }
          }
        },
        {
          "name": "Add an account to a campaign",
          "request": {
            "method": "POST",
            "url": "{{baseUrl}}",
            "description": "Adds one account, with its phone numbers and email addresses, to a campaign list so the campaign can call it. If you leave out list_id, a new list is created for the campaign.\n\nhttps://apidocs.dcdial.com/reference/lists/add-account-to-campaign/",
            "body": {
              "mode": "urlencoded",
              "urlencoded": [
                {
                  "key": "type",
                  "value": "add_leads",
                  "type": "text"
                },
                {
                  "key": "token",
                  "value": "{{token}}",
                  "type": "text"
                },
                {
                  "key": "campaign_id",
                  "value": "1024",
                  "type": "text"
                },
                {
                  "key": "phones",
                  "value": "5550100123,5550100124",
                  "type": "text"
                }
              ]
            }
          }
        },
        {
          "name": "List a campaign’s lists",
          "request": {
            "method": "POST",
            "url": "{{baseUrl}}",
            "description": "Returns the lists attached to a campaign, newest first.\n\nhttps://apidocs.dcdial.com/reference/lists/list-campaign-lists/",
            "body": {
              "mode": "urlencoded",
              "urlencoded": [
                {
                  "key": "type",
                  "value": "get_campaign_lists",
                  "type": "text"
                },
                {
                  "key": "token",
                  "value": "{{token}}",
                  "type": "text"
                },
                {
                  "key": "campaign_id",
                  "value": "1024",
                  "type": "text"
                }
              ]
            }
          }
        },
        {
          "name": "Upload an account file",
          "request": {
            "method": "POST",
            "url": "{{baseUrl}}",
            "description": "Imports accounts from a CSV file into a campaign, using one of your saved import formats to map the columns.\n\nhttps://apidocs.dcdial.com/reference/lists/upload-file/",
            "body": {
              "mode": "formdata",
              "formdata": [
                {
                  "key": "type",
                  "value": "upload_file",
                  "type": "text"
                },
                {
                  "key": "token",
                  "value": "{{token}}",
                  "type": "text"
                },
                {
                  "key": "campaign_id",
                  "value": "1024",
                  "type": "text"
                },
                {
                  "key": "format",
                  "value": "12",
                  "type": "text"
                },
                {
                  "key": "data",
                  "type": "file",
                  "src": []
                }
              ]
            }
          }
        },
        {
          "name": "Get call results",
          "request": {
            "method": "POST",
            "url": "{{baseUrl}}",
            "description": "Returns the dialer’s call results for a phone number.\n\nhttps://apidocs.dcdial.com/reference/lists/get-results/",
            "body": {
              "mode": "urlencoded",
              "urlencoded": [
                {
                  "key": "type",
                  "value": "get_results",
                  "type": "text"
                },
                {
                  "key": "token",
                  "value": "{{token}}",
                  "type": "text"
                },
                {
                  "key": "phone_number",
                  "value": "5551234567",
                  "type": "text"
                }
              ]
            }
          }
        }
      ]
    },
    {
      "name": "Do-Not-Call",
      "item": [
        {
          "name": "Add a number to Do-Not-Call",
          "request": {
            "method": "POST",
            "url": "{{baseUrl}}",
            "description": "Adds a phone number to your Do-Not-Call list, so campaigns stop dialing it. Pass campaign_id to block it for one campaign only.\n\nhttps://apidocs.dcdial.com/reference/dnc/add-number/",
            "body": {
              "mode": "urlencoded",
              "urlencoded": [
                {
                  "key": "type",
                  "value": "add_dnc",
                  "type": "text"
                },
                {
                  "key": "token",
                  "value": "{{token}}",
                  "type": "text"
                },
                {
                  "key": "phone_number",
                  "value": "5550100123",
                  "type": "text"
                }
              ]
            }
          }
        },
        {
          "name": "Remove a number from Do-Not-Call",
          "request": {
            "method": "POST",
            "url": "{{baseUrl}}",
            "description": "Removes a phone number from your Do-Not-Call list. Pass the same campaign_id you used when adding it.\n\nhttps://apidocs.dcdial.com/reference/dnc/remove-number/",
            "body": {
              "mode": "urlencoded",
              "urlencoded": [
                {
                  "key": "type",
                  "value": "delete_dnc",
                  "type": "text"
                },
                {
                  "key": "token",
                  "value": "{{token}}",
                  "type": "text"
                },
                {
                  "key": "phone_number",
                  "value": "5550100123",
                  "type": "text"
                }
              ]
            }
          }
        },
        {
          "name": "List Do-Not-Call numbers",
          "request": {
            "method": "POST",
            "url": "{{baseUrl}}",
            "description": "Lists the numbers on your Do-Not-Call lists, company-wide and per campaign.\n\nhttps://apidocs.dcdial.com/reference/dnc/list-numbers/",
            "body": {
              "mode": "urlencoded",
              "urlencoded": [
                {
                  "key": "type",
                  "value": "get_dncs",
                  "type": "text"
                },
                {
                  "key": "token",
                  "value": "{{token}}",
                  "type": "text"
                }
              ]
            }
          }
        }
      ]
    },
    {
      "name": "Statistics",
      "item": [
        {
          "name": "Campaign summary",
          "request": {
            "method": "POST",
            "url": "{{baseUrl}}",
            "description": "Returns live statistics for one running campaign.\n\nhttps://apidocs.dcdial.com/reference/statistics/campaign-summary/",
            "body": {
              "mode": "urlencoded",
              "urlencoded": [
                {
                  "key": "type",
                  "value": "campaign_summary",
                  "type": "text"
                },
                {
                  "key": "token",
                  "value": "{{token}}",
                  "type": "text"
                },
                {
                  "key": "campaign_id",
                  "value": "1024",
                  "type": "text"
                }
              ]
            }
          }
        },
        {
          "name": "All campaign statistics",
          "request": {
            "method": "POST",
            "url": "{{baseUrl}}",
            "description": "Returns live statistics for all your campaigns.\n\nhttps://apidocs.dcdial.com/reference/statistics/all-campaign-stats/",
            "body": {
              "mode": "urlencoded",
              "urlencoded": [
                {
                  "key": "type",
                  "value": "get_all_stats",
                  "type": "text"
                },
                {
                  "key": "token",
                  "value": "{{token}}",
                  "type": "text"
                },
                {
                  "key": "campaign_id",
                  "value": "1024",
                  "type": "text"
                },
                {
                  "key": "display_status",
                  "value": "PLAY",
                  "type": "text"
                }
              ]
            }
          }
        },
        {
          "name": "Graph data",
          "request": {
            "method": "POST",
            "url": "{{baseUrl}}",
            "description": "Returns a campaign’s statistics as chart-ready series.\n\nhttps://apidocs.dcdial.com/reference/statistics/graph-data/",
            "body": {
              "mode": "urlencoded",
              "urlencoded": [
                {
                  "key": "type",
                  "value": "get_graph_data",
                  "type": "text"
                },
                {
                  "key": "token",
                  "value": "{{token}}",
                  "type": "text"
                },
                {
                  "key": "campaign_id",
                  "value": "1024",
                  "type": "text"
                }
              ]
            }
          }
        },
        {
          "name": "Campaign statistics",
          "request": {
            "method": "POST",
            "url": "{{baseUrl}}",
            "description": "Returns overall statistics for one campaign.\n\nhttps://apidocs.dcdial.com/reference/statistics/campaign-stats/",
            "body": {
              "mode": "urlencoded",
              "urlencoded": [
                {
                  "key": "type",
                  "value": "get_campaign_stats",
                  "type": "text"
                },
                {
                  "key": "token",
                  "value": "{{token}}",
                  "type": "text"
                },
                {
                  "key": "campaign_id",
                  "value": "1024",
                  "type": "text"
                }
              ]
            }
          }
        },
        {
          "name": "All graphs",
          "request": {
            "method": "POST",
            "url": "{{baseUrl}}",
            "description": "Returns chart data for a campaign across statistics (total time, total calls, call percentages, average time).\n\nhttps://apidocs.dcdial.com/reference/statistics/all-graphs/",
            "body": {
              "mode": "urlencoded",
              "urlencoded": [
                {
                  "key": "type",
                  "value": "get_all_graphs",
                  "type": "text"
                },
                {
                  "key": "token",
                  "value": "{{token}}",
                  "type": "text"
                },
                {
                  "key": "campaign_id",
                  "value": "1024",
                  "type": "text"
                }
              ]
            }
          }
        },
        {
          "name": "Dialer usage",
          "request": {
            "method": "POST",
            "url": "{{baseUrl}}",
            "description": "Returns your dialer balance and current usage.\n\nhttps://apidocs.dcdial.com/reference/statistics/dialer-usage/",
            "body": {
              "mode": "urlencoded",
              "urlencoded": [
                {
                  "key": "type",
                  "value": "get_usage",
                  "type": "text"
                },
                {
                  "key": "token",
                  "value": "{{token}}",
                  "type": "text"
                }
              ]
            }
          }
        },
        {
          "name": "Dashboard statistics",
          "request": {
            "method": "POST",
            "url": "{{baseUrl}}",
            "description": "Returns the dashboard figures that summarize campaign performance.\n\nhttps://apidocs.dcdial.com/reference/statistics/dashboard-stats/",
            "body": {
              "mode": "urlencoded",
              "urlencoded": [
                {
                  "key": "type",
                  "value": "get_dashboard_stats",
                  "type": "text"
                },
                {
                  "key": "token",
                  "value": "{{token}}",
                  "type": "text"
                },
                {
                  "key": "campaign_id",
                  "value": "1024",
                  "type": "text"
                }
              ]
            }
          }
        }
      ]
    },
    {
      "name": "IVRs",
      "item": [
        {
          "name": "List IVRs",
          "request": {
            "method": "POST",
            "url": "{{baseUrl}}",
            "description": "Lists your IVR menus, newest first.\n\nhttps://apidocs.dcdial.com/reference/ivrs/list-ivrs/",
            "body": {
              "mode": "urlencoded",
              "urlencoded": [
                {
                  "key": "type",
                  "value": "list_ivrs",
                  "type": "text"
                },
                {
                  "key": "token",
                  "value": "{{token}}",
                  "type": "text"
                }
              ]
            }
          }
        },
        {
          "name": "Add IVR",
          "request": {
            "method": "POST",
            "url": "{{baseUrl}}",
            "description": "Creates an IVR menu that callers navigate with their keypad, using recorded or text-to-speech prompts.\n\nhttps://apidocs.dcdial.com/reference/ivrs/add-ivr/",
            "body": {
              "mode": "urlencoded",
              "urlencoded": [
                {
                  "key": "type",
                  "value": "add_ivr",
                  "type": "text"
                },
                {
                  "key": "token",
                  "value": "{{token}}",
                  "type": "text"
                },
                {
                  "key": "ivr_id",
                  "value": "3",
                  "type": "text"
                },
                {
                  "key": "ivr_name",
                  "value": "Main menu",
                  "type": "text"
                }
              ]
            }
          }
        },
        {
          "name": "Delete IVR",
          "request": {
            "method": "POST",
            "url": "{{baseUrl}}",
            "description": "Permanently deletes an IVR menu.\n\nhttps://apidocs.dcdial.com/reference/ivrs/delete-ivr/",
            "body": {
              "mode": "urlencoded",
              "urlencoded": [
                {
                  "key": "type",
                  "value": "delete_ivr",
                  "type": "text"
                },
                {
                  "key": "token",
                  "value": "{{token}}",
                  "type": "text"
                },
                {
                  "key": "ivr_id",
                  "value": "3",
                  "type": "text"
                }
              ]
            }
          }
        }
      ]
    },
    {
      "name": "Queues",
      "item": [
        {
          "name": "List queues",
          "request": {
            "method": "POST",
            "url": "{{baseUrl}}",
            "description": "Lists your call queues, newest first.\n\nhttps://apidocs.dcdial.com/reference/queues/list-queues/",
            "body": {
              "mode": "urlencoded",
              "urlencoded": [
                {
                  "key": "type",
                  "value": "get_queues",
                  "type": "text"
                },
                {
                  "key": "token",
                  "value": "{{token}}",
                  "type": "text"
                }
              ]
            }
          }
        },
        {
          "name": "Add queue",
          "request": {
            "method": "POST",
            "url": "{{baseUrl}}",
            "description": "Creates a call queue for inbound or outbound calls.\n\nhttps://apidocs.dcdial.com/reference/queues/add-queue/",
            "body": {
              "mode": "urlencoded",
              "urlencoded": [
                {
                  "key": "type",
                  "value": "add_queue",
                  "type": "text"
                },
                {
                  "key": "token",
                  "value": "{{token}}",
                  "type": "text"
                },
                {
                  "key": "group_id",
                  "value": "billing",
                  "type": "text"
                },
                {
                  "key": "group_name",
                  "value": "Billing",
                  "type": "text"
                }
              ]
            }
          }
        },
        {
          "name": "Delete queue",
          "request": {
            "method": "POST",
            "url": "{{baseUrl}}",
            "description": "Permanently deletes a call queue.\n\nhttps://apidocs.dcdial.com/reference/queues/delete-queue/",
            "body": {
              "mode": "urlencoded",
              "urlencoded": [
                {
                  "key": "type",
                  "value": "delete_queue",
                  "type": "text"
                },
                {
                  "key": "token",
                  "value": "{{token}}",
                  "type": "text"
                },
                {
                  "key": "group_id",
                  "value": "billing",
                  "type": "text"
                }
              ]
            }
          }
        }
      ]
    },
    {
      "name": "Users",
      "item": [
        {
          "name": "Add user",
          "request": {
            "method": "POST",
            "url": "{{baseUrl}}",
            "description": "Creates a user in your company with a role (admin, user or agent).\n\nhttps://apidocs.dcdial.com/reference/users/add-user/",
            "body": {
              "mode": "urlencoded",
              "urlencoded": [
                {
                  "key": "type",
                  "value": "add_user",
                  "type": "text"
                },
                {
                  "key": "token",
                  "value": "{{token}}",
                  "type": "text"
                },
                {
                  "key": "first_name",
                  "value": "Jane",
                  "type": "text"
                },
                {
                  "key": "last_name",
                  "value": "Doe",
                  "type": "text"
                },
                {
                  "key": "user",
                  "value": "jane.doe",
                  "type": "text"
                },
                {
                  "key": "pass",
                  "value": "{{token}}",
                  "type": "text"
                },
                {
                  "key": "user_level",
                  "value": "admin",
                  "type": "text"
                },
                {
                  "key": "company_id",
                  "value": "101",
                  "type": "text"
                },
                {
                  "key": "mobile_number",
                  "value": "5551234567",
                  "type": "text"
                },
                {
                  "key": "extension",
                  "value": "1001",
                  "type": "text"
                }
              ]
            }
          }
        },
        {
          "name": "Change password",
          "request": {
            "method": "POST",
            "url": "{{baseUrl}}",
            "description": "Changes the password of the user who owns the token.\n\nhttps://apidocs.dcdial.com/reference/users/change-password/",
            "body": {
              "mode": "urlencoded",
              "urlencoded": [
                {
                  "key": "type",
                  "value": "change_password",
                  "type": "text"
                },
                {
                  "key": "token",
                  "value": "{{token}}",
                  "type": "text"
                },
                {
                  "key": "oldpass",
                  "value": "••••••••",
                  "type": "text"
                },
                {
                  "key": "newpass",
                  "value": "••••••••",
                  "type": "text"
                }
              ]
            }
          }
        },
        {
          "name": "Get profile",
          "request": {
            "method": "POST",
            "url": "{{baseUrl}}",
            "description": "Returns the user’s profile: contact details, email settings and permissions.\n\nhttps://apidocs.dcdial.com/reference/users/get-profile/",
            "body": {
              "mode": "urlencoded",
              "urlencoded": [
                {
                  "key": "type",
                  "value": "get_profile",
                  "type": "text"
                },
                {
                  "key": "token",
                  "value": "{{token}}",
                  "type": "text"
                }
              ]
            }
          }
        },
        {
          "name": "Update profile",
          "request": {
            "method": "POST",
            "url": "{{baseUrl}}",
            "description": "Updates the user’s name, email or mobile number. Fields you leave out stay unchanged.\n\nhttps://apidocs.dcdial.com/reference/users/update-profile/",
            "body": {
              "mode": "urlencoded",
              "urlencoded": [
                {
                  "key": "type",
                  "value": "update_profile",
                  "type": "text"
                },
                {
                  "key": "token",
                  "value": "{{token}}",
                  "type": "text"
                },
                {
                  "key": "full_name",
                  "value": "Jane Doe",
                  "type": "text"
                },
                {
                  "key": "email",
                  "value": "jane@example.com",
                  "type": "text"
                },
                {
                  "key": "mobile_number",
                  "value": "5551234567",
                  "type": "text"
                }
              ]
            }
          }
        },
        {
          "name": "Check permission",
          "request": {
            "method": "POST",
            "url": "{{baseUrl}}",
            "description": "Checks whether the user has a permission on a module. Agents can only hold agent-interface permissions.\n\nhttps://apidocs.dcdial.com/reference/users/check-permission/",
            "body": {
              "mode": "urlencoded",
              "urlencoded": [
                {
                  "key": "type",
                  "value": "check_permission",
                  "type": "text"
                },
                {
                  "key": "token",
                  "value": "{{token}}",
                  "type": "text"
                },
                {
                  "key": "perm_type",
                  "value": "modify",
                  "type": "text"
                },
                {
                  "key": "module",
                  "value": "campaign",
                  "type": "text"
                }
              ]
            }
          }
        }
      ]
    },
    {
      "name": "Notifications",
      "item": [
        {
          "name": "Set notification settings",
          "request": {
            "method": "POST",
            "url": "{{baseUrl}}",
            "description": "Chooses which in-app alerts the user receives and how they are delivered.\n\nhttps://apidocs.dcdial.com/reference/notifications/set-notifications/",
            "body": {
              "mode": "urlencoded",
              "urlencoded": [
                {
                  "key": "type",
                  "value": "set_notifications",
                  "type": "text"
                },
                {
                  "key": "token",
                  "value": "{{token}}",
                  "type": "text"
                },
                {
                  "key": "enable_notification",
                  "value": "Y",
                  "type": "text"
                },
                {
                  "key": "campaign_started",
                  "value": "0",
                  "type": "text"
                },
                {
                  "key": "campaign_stopped",
                  "value": "0",
                  "type": "text"
                }
              ]
            }
          }
        },
        {
          "name": "Get notifications",
          "request": {
            "method": "POST",
            "url": "{{baseUrl}}",
            "description": "Returns the user’s unread notifications.\n\nhttps://apidocs.dcdial.com/reference/notifications/get-notifications/",
            "body": {
              "mode": "urlencoded",
              "urlencoded": [
                {
                  "key": "type",
                  "value": "get_notifications",
                  "type": "text"
                },
                {
                  "key": "token",
                  "value": "{{token}}",
                  "type": "text"
                }
              ]
            }
          }
        },
        {
          "name": "Clear notifications",
          "request": {
            "method": "POST",
            "url": "{{baseUrl}}",
            "description": "Marks all of the user’s notifications as read. They stay in the notification center.\n\nhttps://apidocs.dcdial.com/reference/notifications/clear-notifications/",
            "body": {
              "mode": "urlencoded",
              "urlencoded": [
                {
                  "key": "type",
                  "value": "clear_notifications",
                  "type": "text"
                },
                {
                  "key": "token",
                  "value": "{{token}}",
                  "type": "text"
                }
              ]
            }
          }
        },
        {
          "name": "Get notification settings",
          "request": {
            "method": "POST",
            "url": "{{baseUrl}}",
            "description": "Returns which alerts the user has turned on.\n\nhttps://apidocs.dcdial.com/reference/notifications/get-notification-settings/",
            "body": {
              "mode": "urlencoded",
              "urlencoded": [
                {
                  "key": "type",
                  "value": "get_notifications_settings",
                  "type": "text"
                },
                {
                  "key": "token",
                  "value": "{{token}}",
                  "type": "text"
                }
              ]
            }
          }
        }
      ]
    },
    {
      "name": "Payments",
      "item": [
        {
          "name": "Create payment agreement",
          "request": {
            "method": "POST",
            "url": "{{baseUrl}}",
            "description": "Creates a payment agreement (a schedule of payments) for an account and sends it to the account holder by SMS, email or both to sign.\n\nhttps://apidocs.dcdial.com/reference/payments/create-agreement/",
            "body": {
              "mode": "urlencoded",
              "urlencoded": [
                {
                  "key": "type",
                  "value": "create_payment_plan",
                  "type": "text"
                },
                {
                  "key": "token",
                  "value": "{{token}}",
                  "type": "text"
                },
                {
                  "key": "account_id",
                  "value": "ACC-10045",
                  "type": "text"
                },
                {
                  "key": "billing_start_date",
                  "value": "2026-11-01",
                  "type": "text"
                },
                {
                  "key": "total_payments",
                  "value": "6",
                  "type": "text"
                },
                {
                  "key": "amount",
                  "value": "150",
                  "type": "text"
                },
                {
                  "key": "payment_schedule",
                  "value": "daily",
                  "type": "text"
                },
                {
                  "key": "communication_method",
                  "value": "sms",
                  "type": "text"
                },
                {
                  "key": "phone_number",
                  "value": "5551234567",
                  "type": "text"
                },
                {
                  "key": "email",
                  "value": "jane@example.com",
                  "type": "text"
                },
                {
                  "key": "company_id",
                  "value": "101",
                  "type": "text"
                }
              ]
            }
          }
        },
        {
          "name": "Get agreement details",
          "request": {
            "method": "POST",
            "url": "{{baseUrl}}",
            "description": "Returns a payment agreement with its schedule and payment history.\n\nhttps://apidocs.dcdial.com/reference/payments/agreement-details/",
            "body": {
              "mode": "urlencoded",
              "urlencoded": [
                {
                  "key": "type",
                  "value": "agreement_details",
                  "type": "text"
                },
                {
                  "key": "token",
                  "value": "{{token}}",
                  "type": "text"
                },
                {
                  "key": "account_id",
                  "value": "ACC-10045",
                  "type": "text"
                },
                {
                  "key": "company_id",
                  "value": "101",
                  "type": "text"
                }
              ]
            }
          }
        },
        {
          "name": "Get payment schedule",
          "request": {
            "method": "POST",
            "url": "{{baseUrl}}",
            "description": "Returns every scheduled payment of a payment agreement or recurring plan, with dates, amounts, the balance after each payment and its status.\n\nhttps://apidocs.dcdial.com/reference/payments/payment-schedule/",
            "body": {
              "mode": "urlencoded",
              "urlencoded": [
                {
                  "key": "type",
                  "value": "get_schedules",
                  "type": "text"
                },
                {
                  "key": "token",
                  "value": "{{token}}",
                  "type": "text"
                },
                {
                  "key": "schedule_id",
                  "value": "77120",
                  "type": "text"
                }
              ]
            }
          }
        },
        {
          "name": "Get agreement document",
          "request": {
            "method": "POST",
            "url": "{{baseUrl}}",
            "description": "Returns the signed agreement document: account holder details, payment schedule, terms and authorization.\n\nhttps://apidocs.dcdial.com/reference/payments/agreement-document/",
            "body": {
              "mode": "urlencoded",
              "urlencoded": [
                {
                  "key": "type",
                  "value": "get_agreement_doc",
                  "type": "text"
                },
                {
                  "key": "token",
                  "value": "{{token}}",
                  "type": "text"
                },
                {
                  "key": "company_id",
                  "value": "101",
                  "type": "text"
                },
                {
                  "key": "agreement_id",
                  "value": "5521",
                  "type": "text"
                }
              ]
            }
          }
        },
        {
          "name": "Cancel agreement",
          "request": {
            "method": "POST",
            "url": "{{baseUrl}}",
            "description": "Cancels a payment agreement and all its future payments. The account holder is notified.\n\nhttps://apidocs.dcdial.com/reference/payments/cancel-agreement/",
            "body": {
              "mode": "urlencoded",
              "urlencoded": [
                {
                  "key": "type",
                  "value": "cancel_payment_plan",
                  "type": "text"
                },
                {
                  "key": "token",
                  "value": "{{token}}",
                  "type": "text"
                },
                {
                  "key": "company_id",
                  "value": "101",
                  "type": "text"
                },
                {
                  "key": "agreement_id",
                  "value": "5521",
                  "type": "text"
                }
              ]
            }
          }
        },
        {
          "name": "Record a manual payment",
          "request": {
            "method": "POST",
            "url": "{{baseUrl}}",
            "description": "Records a payment received outside DCDial (cash, check, wire…) and applies it to the account balance. No money is moved.\n\nhttps://apidocs.dcdial.com/reference/payments/add-manual-payment/",
            "body": {
              "mode": "urlencoded",
              "urlencoded": [
                {
                  "key": "type",
                  "value": "add_payment",
                  "type": "text"
                },
                {
                  "key": "token",
                  "value": "{{token}}",
                  "type": "text"
                },
                {
                  "key": "account_id",
                  "value": "ACC-10045",
                  "type": "text"
                },
                {
                  "key": "payment_date",
                  "value": "2026-10-15",
                  "type": "text"
                },
                {
                  "key": "payment_method",
                  "value": "WT",
                  "type": "text"
                },
                {
                  "key": "amount",
                  "value": "150",
                  "type": "text"
                },
                {
                  "key": "company_id",
                  "value": "101",
                  "type": "text"
                }
              ]
            }
          }
        },
        {
          "name": "Void a payment",
          "request": {
            "method": "POST",
            "url": "{{baseUrl}}",
            "description": "Voids a recorded payment, for example after a refund, NSF or chargeback, and reverses it on the account balance.\n\nhttps://apidocs.dcdial.com/reference/payments/void-payment/",
            "body": {
              "mode": "urlencoded",
              "urlencoded": [
                {
                  "key": "type",
                  "value": "remove_payment",
                  "type": "text"
                },
                {
                  "key": "token",
                  "value": "{{token}}",
                  "type": "text"
                },
                {
                  "key": "account_id",
                  "value": "ACC-10045",
                  "type": "text"
                },
                {
                  "key": "reason",
                  "value": "refunded",
                  "type": "text"
                },
                {
                  "key": "payment_id",
                  "value": "90311",
                  "type": "text"
                },
                {
                  "key": "company_id",
                  "value": "101",
                  "type": "text"
                }
              ]
            }
          }
        },
        {
          "name": "Refund a payment",
          "request": {
            "method": "POST",
            "url": "{{baseUrl}}",
            "description": "Refunds all or part of a card or ACH payment to the original payment method.\n\nhttps://apidocs.dcdial.com/reference/payments/refund-payment/",
            "body": {
              "mode": "urlencoded",
              "urlencoded": [
                {
                  "key": "type",
                  "value": "payment_refund",
                  "type": "text"
                },
                {
                  "key": "token",
                  "value": "{{token}}",
                  "type": "text"
                },
                {
                  "key": "account_id",
                  "value": "ACC-10045",
                  "type": "text"
                },
                {
                  "key": "amount",
                  "value": "150",
                  "type": "text"
                },
                {
                  "key": "transaction_id",
                  "value": "ch_3Q8x2e",
                  "type": "text"
                },
                {
                  "key": "order_id",
                  "value": "77412",
                  "type": "text"
                },
                {
                  "key": "company_id",
                  "value": "101",
                  "type": "text"
                }
              ]
            }
          }
        },
        {
          "name": "Process a payment",
          "request": {
            "method": "POST",
            "url": "{{baseUrl}}",
            "description": "Charges a card or bank account now, once or on a recurring schedule.\n\nhttps://apidocs.dcdial.com/reference/payments/process-payment/",
            "body": {
              "mode": "urlencoded",
              "urlencoded": [
                {
                  "key": "type",
                  "value": "charge_customer",
                  "type": "text"
                },
                {
                  "key": "token",
                  "value": "{{token}}",
                  "type": "text"
                },
                {
                  "key": "account_id",
                  "value": "ACC-10045",
                  "type": "text"
                },
                {
                  "key": "amount",
                  "value": "150",
                  "type": "text"
                },
                {
                  "key": "payment_method",
                  "value": "CC",
                  "type": "text"
                },
                {
                  "key": "phone_number",
                  "value": "5551234567",
                  "type": "text"
                },
                {
                  "key": "company_id",
                  "value": "101",
                  "type": "text"
                },
                {
                  "key": "agent",
                  "value": "jane.agent",
                  "type": "text"
                },
                {
                  "key": "currency_code",
                  "value": "USD",
                  "type": "text"
                },
                {
                  "key": "first_name",
                  "value": "Jane",
                  "type": "text"
                },
                {
                  "key": "last_name",
                  "value": "Doe",
                  "type": "text"
                }
              ]
            }
          }
        },
        {
          "name": "Create a payment link",
          "request": {
            "method": "POST",
            "url": "{{baseUrl}}",
            "description": "Creates a secure payment link for an account. Send it yourself, or have DCDial text it to the account holder.\n\nhttps://apidocs.dcdial.com/reference/payments/payment-link/",
            "body": {
              "mode": "urlencoded",
              "urlencoded": [
                {
                  "key": "type",
                  "value": "get_payment_link",
                  "type": "text"
                },
                {
                  "key": "token",
                  "value": "{{token}}",
                  "type": "text"
                },
                {
                  "key": "account_id",
                  "value": "ACC-10045",
                  "type": "text"
                },
                {
                  "key": "company_id",
                  "value": "101",
                  "type": "text"
                }
              ]
            }
          }
        },
        {
          "name": "Get payment status",
          "request": {
            "method": "POST",
            "url": "{{baseUrl}}",
            "description": "Returns the status of a payment by invoice or transaction ID.\n\nhttps://apidocs.dcdial.com/reference/payments/payment-status/",
            "body": {
              "mode": "urlencoded",
              "urlencoded": [
                {
                  "key": "type",
                  "value": "get_payment_status",
                  "type": "text"
                },
                {
                  "key": "token",
                  "value": "{{token}}",
                  "type": "text"
                },
                {
                  "key": "invoice_id",
                  "value": "INV-88812",
                  "type": "text"
                },
                {
                  "key": "transaction_id",
                  "value": "ch_3Q8x2e",
                  "type": "text"
                },
                {
                  "key": "company_id",
                  "value": "101",
                  "type": "text"
                }
              ]
            }
          }
        }
      ]
    },
    {
      "name": "SMS",
      "item": [
        {
          "name": "Send a text message",
          "request": {
            "method": "POST",
            "url": "{{baseUrl}}",
            "description": "Sends a text message from one of your numbers to a phone number, with your own text or a saved template.\n\nhttps://apidocs.dcdial.com/reference/sms/send-message/",
            "body": {
              "mode": "urlencoded",
              "urlencoded": [
                {
                  "key": "type",
                  "value": "send_text_message",
                  "type": "text"
                },
                {
                  "key": "token",
                  "value": "{{token}}",
                  "type": "text"
                },
                {
                  "key": "company_id",
                  "value": "101",
                  "type": "text"
                },
                {
                  "key": "phone_number",
                  "value": "5551234567",
                  "type": "text"
                },
                {
                  "key": "caller_id",
                  "value": "5559876543",
                  "type": "text"
                },
                {
                  "key": "use_template",
                  "value": "Y",
                  "type": "text"
                },
                {
                  "key": "sms_text",
                  "value": "Your payment of $150.00 was received. Thank you!",
                  "type": "text"
                }
              ]
            }
          }
        },
        {
          "name": "Retrieve sent messages",
          "request": {
            "method": "POST",
            "url": "{{baseUrl}}",
            "description": "Lists the text messages you sent between two dates.\n\nhttps://apidocs.dcdial.com/reference/sms/sent-messages/",
            "body": {
              "mode": "urlencoded",
              "urlencoded": [
                {
                  "key": "type",
                  "value": "retrieve_sent_messages",
                  "type": "text"
                },
                {
                  "key": "token",
                  "value": "{{token}}",
                  "type": "text"
                },
                {
                  "key": "company_id",
                  "value": "101",
                  "type": "text"
                },
                {
                  "key": "start_date",
                  "value": "2026-10-01",
                  "type": "text"
                },
                {
                  "key": "end_date",
                  "value": "2026-10-15",
                  "type": "text"
                }
              ]
            }
          }
        }
      ]
    },
    {
      "name": "Content",
      "item": [
        {
          "name": "Get content",
          "request": {
            "method": "POST",
            "url": "{{baseUrl}}",
            "description": "Returns public content used by DCDial client applications. No token needed.\n\nhttps://apidocs.dcdial.com/reference/content/get-content/",
            "body": {
              "mode": "urlencoded",
              "urlencoded": [
                {
                  "key": "type",
                  "value": "get_content",
                  "type": "text"
                }
              ]
            }
          }
        }
      ]
    }
  ]
}