{ "opencollection": "1.0.0", "info": { "name": "PureCloud Platform Agent Assistants Outbound API", "version": "v2" }, "items": [ { "info": { "name": "Outbound", "type": "folder" }, "items": [ { "info": { "name": "Send notification that an agent's state changed ", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v2/outbound/campaigns/:campaignId/agents/:userId", "params": [ { "name": "campaignId", "value": "", "type": "path", "description": "Campaign ID" }, { "name": "userId", "value": "", "type": "path", "description": "Agent's user ID" } ] }, "docs": "New agent state." }, { "info": { "name": "Get attempt limits", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/outbound/attemptlimits/:attemptLimitsId", "params": [ { "name": "attemptLimitsId", "value": "", "type": "path", "description": "Attempt limits ID" } ] }, "docs": "Get attempt limits" }, { "info": { "name": "Update attempt limits", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v2/outbound/attemptlimits/:attemptLimitsId", "params": [ { "name": "attemptLimitsId", "value": "", "type": "path", "description": "Attempt limits ID" } ] }, "docs": "Update attempt limits" }, { "info": { "name": "Delete attempt limits", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v2/outbound/attemptlimits/:attemptLimitsId", "params": [ { "name": "attemptLimitsId", "value": "", "type": "path", "description": "Attempt limits ID" } ] }, "docs": "Delete attempt limits" }, { "info": { "name": "Query attempt limits list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/outbound/attemptlimits", "params": [ { "name": "pageSize", "value": "", "type": "query", "description": "Page size. The max that will be returned is 100." }, { "name": "pageNumber", "value": "", "type": "query", "description": "Page number" }, { "name": "allowEmptyResult", "value": "", "type": "query", "description": "Whether to return an empty page when there are no results for that page" }, { "name": "filterType", "value": "", "type": "query", "description": "Filter type" }, { "name": "name", "value": "", "type": "query", "description": "Name" }, { "name": "sortBy", "value": "", "type": "query", "description": "Sort by" }, { "name": "sortOrder", "value": "", "type": "query", "description": "Sort order" } ] }, "docs": "Query attempt limits list" }, { "info": { "name": "Create attempt limits", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/outbound/attemptlimits" }, "docs": "Create attempt limits" }, { "info": { "name": "Get a dialer call analysis response set.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/outbound/callanalysisresponsesets/:callAnalysisSetId", "params": [ { "name": "callAnalysisSetId", "value": "", "type": "path", "description": "Call Analysis Response Set ID" } ] }, "docs": "Get a dialer call analysis response set." }, { "info": { "name": "Update a dialer call analysis response set.", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v2/outbound/callanalysisresponsesets/:callAnalysisSetId", "params": [ { "name": "callAnalysisSetId", "value": "", "type": "path", "description": "Call Analysis Response Set ID" } ] }, "docs": "Update a dialer call analysis response set." }, { "info": { "name": "Delete a dialer call analysis response set.", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v2/outbound/callanalysisresponsesets/:callAnalysisSetId", "params": [ { "name": "callAnalysisSetId", "value": "", "type": "path", "description": "Call Analysis Response Set ID" } ] }, "docs": "Delete a dialer call analysis response set." }, { "info": { "name": "Query a list of dialer call analysis response sets.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/outbound/callanalysisresponsesets", "params": [ { "name": "pageSize", "value": "", "type": "query", "description": "Page size. The max that will be returned is 100." }, { "name": "pageNumber", "value": "", "type": "query", "description": "Page number" }, { "name": "allowEmptyResult", "value": "", "type": "query", "description": "Whether to return an empty page when there are no results for that page" }, { "name": "filterType", "value": "", "type": "query", "description": "Filter type" }, { "name": "name", "value": "", "type": "query", "description": "Name" }, { "name": "sortBy", "value": "", "type": "query", "description": "Sort by" }, { "name": "sortOrder", "value": "", "type": "query", "description": "Sort order" } ] }, "docs": "Query a list of dialer call analysis response sets." }, { "info": { "name": "Create a dialer call analysis response set.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/outbound/callanalysisresponsesets" }, "docs": "Create a dialer call analysis response set." }, { "info": { "name": "Get callable time set", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/outbound/callabletimesets/:callableTimeSetId", "params": [ { "name": "callableTimeSetId", "value": "", "type": "path", "description": "Callable Time Set ID" } ] }, "docs": "Get callable time set" }, { "info": { "name": "Update callable time set", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v2/outbound/callabletimesets/:callableTimeSetId", "params": [ { "name": "callableTimeSetId", "value": "", "type": "path", "description": "Callable Time Set ID" } ] }, "docs": "Update callable time set" }, { "info": { "name": "Delete callable time set", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v2/outbound/callabletimesets/:callableTimeSetId", "params": [ { "name": "callableTimeSetId", "value": "", "type": "path", "description": "Callable Time Set ID" } ] }, "docs": "Delete callable time set" }, { "info": { "name": "Query callable time set list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/outbound/callabletimesets", "params": [ { "name": "pageSize", "value": "", "type": "query", "description": "Page size. The max that will be returned is 100." }, { "name": "pageNumber", "value": "", "type": "query", "description": "Page number" }, { "name": "allowEmptyResult", "value": "", "type": "query", "description": "Whether to return an empty page when there are no results for that page" }, { "name": "filterType", "value": "", "type": "query", "description": "Filter type" }, { "name": "name", "value": "", "type": "query", "description": "Name" }, { "name": "sortBy", "value": "", "type": "query", "description": "Sort by" }, { "name": "sortOrder", "value": "", "type": "query", "description": "Sort order" } ] }, "docs": "Query callable time set list" }, { "info": { "name": "Create callable time set", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/outbound/callabletimesets" }, "docs": "Create callable time set" }, { "info": { "name": "Schedule a Callback for a Dialer Campaign (Deprecated)", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/outbound/campaigns/:campaignId/callback/schedule", "params": [ { "name": "campaignId", "value": "", "type": "path", "description": "Campaign ID" } ] }, "docs": "This endpoint is deprecated and may have unexpected results. Please use \"/conversations/{conversationId}/participants/{participantId}/callbacks instead.\"" }, { "info": { "name": "Get a basic Campaign information object", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/outbound/campaigns/divisionviews/:campaignId", "params": [ { "name": "campaignId", "value": "", "type": "path", "description": "Campaign ID" } ] }, "docs": "This returns a simplified version of a Campaign, consisting of name and division." }, { "info": { "name": "Query a list of basic Campaign information objects", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/outbound/campaigns/divisionviews", "params": [ { "name": "pageSize", "value": "", "type": "query", "description": "Page size. The max that will be returned is 100." }, { "name": "pageNumber", "value": "", "type": "query", "description": "Page number" }, { "name": "filterType", "value": "", "type": "query", "description": "Filter type" }, { "name": "name", "value": "", "type": "query", "description": "Name" }, { "name": "id", "value": "", "type": "query", "description": "id" }, { "name": "sortBy", "value": "", "type": "query", "description": "Sort by" }, { "name": "sortOrder", "value": "", "type": "query", "description": "Sort order" } ] }, "docs": "This returns a simplified version of a Campaign, consisting of name and division." }, { "info": { "name": "Get dialer campaign interactions.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/outbound/campaigns/:campaignId/interactions", "params": [ { "name": "campaignId", "value": "", "type": "path", "description": "Campaign ID" } ] }, "docs": "Get dialer campaign interactions." }, { "info": { "name": "Get line distribution information for campaigns using same Edge Group or Site as given campaign", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/outbound/campaigns/:campaignId/linedistribution", "params": [ { "name": "campaignId", "value": "", "type": "path", "description": "Campaign ID" }, { "name": "includeOnlyActiveCampaigns", "value": "", "type": "query", "description": "If true will return only active Campaigns" }, { "name": "edgeGroupId", "value": "", "type": "query", "description": "Edge group to be used in line distribution calculations instead of current Campaign's Edge Group. Campaign's Site and Edge Group are mutually exclusive." }, { "name": "siteId", "value": "", "type": "query", "description": "Site to be used in line distribution calculations instead of current Campaign's Site. Campaign's Site and Edge Group are mutually exclusive." }, { "name": "useWeight", "value": "", "type": "query", "description": "Enable usage of weight, this value overrides current Campaign's setting in line distribution calculations" }, { "name": "relativeWeight", "value": "", "type": "query", "description": "Relative weight to be used in line distribution calculations instead of current Campaign's relative weight" }, { "name": "outboundLineCount", "value": "", "type": "query", "description": "The number of outbound lines to be used in line distribution calculations, instead of current Campaign's Outbound Lines Count" } ] }, "docs": "Get line distribution information for campaigns using same Edge Group or Site as given campaign" }, { "info": { "name": "Get dialer campaign.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/outbound/campaigns/:campaignId", "params": [ { "name": "campaignId", "value": "", "type": "path", "description": "Campaign ID" } ] }, "docs": "Get dialer campaign." }, { "info": { "name": "Update a campaign.", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v2/outbound/campaigns/:campaignId", "params": [ { "name": "campaignId", "value": "", "type": "path", "description": "Campaign ID" }, { "name": "useMaxCallsPerAgentDecimal", "value": "", "type": "query", "description": "Use maxCallsPerAgent with decimal precision" } ] }, "docs": "Update a campaign." }, { "info": { "name": "Update a campaign.", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v2/outbound/campaigns/:campaignId", "params": [ { "name": "campaignId", "value": "", "type": "path", "description": "Campaign ID" } ] }, "docs": "Update a campaign." }, { "info": { "name": "Delete a campaign.", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v2/outbound/campaigns/:campaignId", "params": [ { "name": "campaignId", "value": "", "type": "path", "description": "Campaign ID" } ] }, "docs": "Delete a campaign." }, { "info": { "name": "Get a preview of how agents will be mapped to this campaign's contact list.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/outbound/campaigns/:campaignId/agentownedmappingpreview/results", "params": [ { "name": "campaignId", "value": "", "type": "path", "description": "Campaign ID" } ] }, "docs": "Get a preview of how agents will be mapped to this campaign's contact list." }, { "info": { "name": "Initiate request for a preview of how agents will be mapped to this campaign's contact list.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/outbound/campaigns/:campaignId/agentownedmappingpreview", "params": [ { "name": "campaignId", "value": "", "type": "path", "description": "Campaign ID" } ] }, "docs": "Initiate request for a preview of how agents will be mapped to this campaign's contact list." }, { "info": { "name": "Get campaign diagnostics", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/outbound/campaigns/:campaignId/diagnostics", "params": [ { "name": "campaignId", "value": "", "type": "path", "description": "Campaign ID" } ] }, "docs": "Get campaign diagnostics" }, { "info": { "name": "Get campaign progress", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/outbound/campaigns/:campaignId/progress", "params": [ { "name": "campaignId", "value": "", "type": "path", "description": "Campaign ID" } ] }, "docs": "Get campaign progress" }, { "info": { "name": "Reset campaign progress and recycle the campaign", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v2/outbound/campaigns/:campaignId/progress", "params": [ { "name": "campaignId", "value": "", "type": "path", "description": "Campaign ID" } ] }, "docs": "Reset campaign progress and recycle the campaign" }, { "info": { "name": "Get the remaining and total contact count for each skill combination in a skills campaign", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/outbound/campaigns/:campaignId/skillcombinations", "params": [ { "name": "campaignId", "value": "", "type": "path", "description": "Campaign ID" }, { "name": "pageNumber", "value": "", "type": "query", "description": "Page number" }, { "name": "pageSize", "value": "", "type": "query", "description": "Page size" } ] }, "docs": "Get the remaining and total contact count for each skill combination in a skills campaign" }, { "info": { "name": "Start the campaign", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/outbound/campaigns/:campaignId/start", "params": [ { "name": "campaignId", "value": "", "type": "path", "description": "Campaign ID" } ] }, "docs": "Start the campaign" }, { "info": { "name": "Stop the campaign", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/outbound/campaigns/:campaignId/stop", "params": [ { "name": "campaignId", "value": "", "type": "path", "description": "Campaign ID" } ] }, "docs": "Stop the campaign" }, { "info": { "name": "Get Campaign Rule", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/outbound/campaignrules/:campaignRuleId", "params": [ { "name": "campaignRuleId", "value": "", "type": "path", "description": "Campaign Rule ID" } ] }, "docs": "Get Campaign Rule" }, { "info": { "name": "Update Campaign Rule", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v2/outbound/campaignrules/:campaignRuleId", "params": [ { "name": "campaignRuleId", "value": "", "type": "path", "description": "Campaign Rule ID" } ] }, "docs": "Update Campaign Rule" }, { "info": { "name": "Delete Campaign Rule", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v2/outbound/campaignrules/:campaignRuleId", "params": [ { "name": "campaignRuleId", "value": "", "type": "path", "description": "Campaign Rule ID" } ] }, "docs": "Delete Campaign Rule" }, { "info": { "name": "Query Campaign Rule list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/outbound/campaignrules", "params": [ { "name": "pageSize", "value": "", "type": "query", "description": "Page size. The max that will be returned is 100." }, { "name": "pageNumber", "value": "", "type": "query", "description": "Page number" }, { "name": "allowEmptyResult", "value": "", "type": "query", "description": "Whether to return an empty page when there are no results for that page" }, { "name": "filterType", "value": "", "type": "query", "description": "Filter type" }, { "name": "name", "value": "", "type": "query", "description": "Name" }, { "name": "sortBy", "value": "", "type": "query", "description": "Sort by" }, { "name": "sortOrder", "value": "", "type": "query", "description": "Sort order" } ] }, "docs": "Query Campaign Rule list" }, { "info": { "name": "Create Campaign Rule", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/outbound/campaignrules" }, "docs": "Create Campaign Rule" }, { "info": { "name": "Get a dialer campaign schedule.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/outbound/schedules/campaigns/:campaignId", "params": [ { "name": "campaignId", "value": "", "type": "path", "description": "Campaign ID" } ] }, "docs": "Get a dialer campaign schedule." }, { "info": { "name": "Update a new campaign schedule.", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v2/outbound/schedules/campaigns/:campaignId", "params": [ { "name": "campaignId", "value": "", "type": "path", "description": "Campaign ID" } ] }, "docs": "Update a new campaign schedule." }, { "info": { "name": "Delete a dialer campaign schedule.", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v2/outbound/schedules/campaigns/:campaignId", "params": [ { "name": "campaignId", "value": "", "type": "path", "description": "Campaign ID" } ] }, "docs": "Delete a dialer campaign schedule." }, { "info": { "name": "Query for a list of dialer campaign schedules.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/outbound/schedules/campaigns" }, "docs": "Query for a list of dialer campaign schedules." }, { "info": { "name": "Get statistics about a Dialer Campaign", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/outbound/campaigns/:campaignId/stats", "params": [ { "name": "campaignId", "value": "", "type": "path", "description": "Campaign ID" } ] }, "docs": "Get statistics about a Dialer Campaign" }, { "info": { "name": "Get performance data for a list of campaigns", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/outbound/campaigns/performance/query" }, "docs": "Get performance data for a list of campaigns" }, { "info": { "name": "Get progress for a list of campaigns", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/outbound/campaigns/progress" }, "docs": "Get progress for a list of campaigns" }, { "info": { "name": "Query a list of dialer campaigns.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/outbound/campaigns", "params": [ { "name": "pageSize", "value": "", "type": "query", "description": "Page size. The max that will be returned is 100." }, { "name": "pageNumber", "value": "", "type": "query", "description": "Page number" }, { "name": "filterType", "value": "", "type": "query", "description": "Filter type" }, { "name": "name", "value": "", "type": "query", "description": "Name" }, { "name": "id", "value": "", "type": "query", "description": "id" }, { "name": "contactListId", "value": "", "type": "query", "description": "Contact List ID" }, { "name": "dncListIds", "value": "", "type": "query", "description": "DNC list ID" }, { "name": "distributionQueueId", "value": "", "type": "query", "description": "Distribution queue ID" }, { "name": "edgeGroupId", "value": "", "type": "query", "description": "Edge group ID" }, { "name": "callAnalysisResponseSetId", "value": "", "type": "query", "description": "Call analysis response set ID" }, { "name": "divisionId", "value": "", "type": "query", "description": "Division ID(s)" }, { "name": "sortBy", "value": "", "type": "query", "description": "Sort by" }, { "name": "sortOrder", "value": "", "type": "query", "description": "Sort order" } ] }, "docs": "Query a list of dialer campaigns." }, { "info": { "name": "Create a campaign.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/outbound/campaigns", "params": [ { "name": "useMaxCallsPerAgentDecimal", "value": "", "type": "query", "description": "Use maxCallsPerAgent with decimal precision" } ] }, "docs": "Create a campaign." }, { "info": { "name": "Query across all types of campaigns", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/outbound/campaigns/all/divisionviews", "params": [ { "name": "pageSize", "value": "", "type": "query", "description": "Page size" }, { "name": "pageNumber", "value": "", "type": "query", "description": "Page number" }, { "name": "id", "value": "", "type": "query", "description": "Campaign ID(s)" }, { "name": "name", "value": "", "type": "query", "description": "Campaign name(s)" }, { "name": "divisionId", "value": "", "type": "query", "description": "Division ID(s)" }, { "name": "mediaType", "value": "", "type": "query", "description": "Media type(s)" }, { "name": "sortOrder", "value": "", "type": "query", "description": "Sort order" } ] }, "docs": "Query across all types of campaigns" }, { "info": { "name": "Query across all types of campaigns by division", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/outbound/campaigns/all", "params": [ { "name": "pageSize", "value": "", "type": "query", "description": "Page size" }, { "name": "pageNumber", "value": "", "type": "query", "description": "Page number" }, { "name": "id", "value": "", "type": "query", "description": "Campaign ID(s)" }, { "name": "name", "value": "", "type": "query", "description": "Campaign name(s)" }, { "name": "divisionId", "value": "", "type": "query", "description": "Division ID(s)" }, { "name": "mediaType", "value": "", "type": "query", "description": "Media type(s)" }, { "name": "sortOrder", "value": "", "type": "query", "description": "Sort order" } ] }, "docs": "Query across all types of campaigns by division" }, { "info": { "name": "Get a basic ContactList information object", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/outbound/contactlists/divisionviews/:contactListId", "params": [ { "name": "contactListId", "value": "", "type": "path", "description": "Contactlist ID" }, { "name": "includeImportStatus", "value": "", "type": "query", "description": "Include import status" }, { "name": "includeSize", "value": "", "type": "query", "description": "Include size" } ] }, "docs": "This returns a simplified version of a ContactList, consisting of the name, division, column names, phone columns, import status, and size." }, { "info": { "name": "Query a list of simplified contact list objects.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/outbound/contactlists/divisionviews", "params": [ { "name": "includeImportStatus", "value": "", "type": "query", "description": "Include import status" }, { "name": "includeSize", "value": "", "type": "query", "description": "Include size" }, { "name": "pageSize", "value": "", "type": "query", "description": "Page size. The max that will be returned is 100." }, { "name": "pageNumber", "value": "", "type": "query", "description": "Page number" }, { "name": "filterType", "value": "", "type": "query", "description": "Filter type" }, { "name": "name", "value": "", "type": "query", "description": "Name" }, { "name": "id", "value": "", "type": "query", "description": "id" }, { "name": "sortBy", "value": "", "type": "query", "description": "Sort by" }, { "name": "sortOrder", "value": "", "type": "query", "description": "Sort order" } ] }, "docs": "This return a simplified version of contact lists, consisting of the name, division, column names, phone columns, import status, and size." }, { "info": { "name": "Get the URI of a contact list export.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/outbound/contactlists/:contactListId/export", "params": [ { "name": "contactListId", "value": "", "type": "path", "description": "ContactList ID" }, { "name": "download", "value": "", "type": "query", "description": "Redirect to download uri" } ] }, "docs": "Get the URI of a contact list export." }, { "info": { "name": "Initiate the export of a contact list.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/outbound/contactlists/:contactListId/export", "params": [ { "name": "contactListId", "value": "", "type": "path", "description": "ContactList ID" } ] }, "docs": "Returns 200 if received OK." }, { "info": { "name": "Get a preview of the output of a contact list filter", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/outbound/contactlistfilters/preview" }, "docs": "Get a preview of the output of a contact list filter" }, { "info": { "name": "Get Contact list filter", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/outbound/contactlistfilters/:contactListFilterId", "params": [ { "name": "contactListFilterId", "value": "", "type": "path", "description": "Contact List Filter ID" } ] }, "docs": "Get Contact list filter" }, { "info": { "name": "Update Contact List Filter", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v2/outbound/contactlistfilters/:contactListFilterId", "params": [ { "name": "contactListFilterId", "value": "", "type": "path", "description": "Contact List Filter ID" } ] }, "docs": "Update Contact List Filter" }, { "info": { "name": "Delete Contact List Filter", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v2/outbound/contactlistfilters/:contactListFilterId", "params": [ { "name": "contactListFilterId", "value": "", "type": "path", "description": "Contact List Filter ID" } ] }, "docs": "Delete Contact List Filter" }, { "info": { "name": "Retrieve multiple contact list filters", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/outbound/contactlistfilters/bulk/retrieve" }, "docs": "Retrieve multiple contact list filters" }, { "info": { "name": "Query Contact list filters", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/outbound/contactlistfilters", "params": [ { "name": "pageSize", "value": "", "type": "query", "description": "Page size. The max that will be returned is 100." }, { "name": "pageNumber", "value": "", "type": "query", "description": "Page number" }, { "name": "allowEmptyResult", "value": "", "type": "query", "description": "Whether to return an empty page when there are no results for that page" }, { "name": "filterType", "value": "", "type": "query", "description": "Filter type" }, { "name": "name", "value": "", "type": "query", "description": "Name" }, { "name": "sortBy", "value": "", "type": "query", "description": "Sort by" }, { "name": "sortOrder", "value": "", "type": "query", "description": "Sort order" }, { "name": "contactListId", "value": "", "type": "query", "description": "Contact List ID" } ] }, "docs": "Query Contact list filters" }, { "info": { "name": "Create Contact List Filter", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/outbound/contactlistfilters" }, "docs": "Create Contact List Filter" }, { "info": { "name": "Get dialer contactList import status.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/outbound/contactlists/:contactListId/importstatus", "params": [ { "name": "contactListId", "value": "", "type": "path", "description": "ContactList ID" } ] }, "docs": "Get dialer contactList import status." }, { "info": { "name": "Get a dialer contact list.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/outbound/contactlists/:contactListId", "params": [ { "name": "contactListId", "value": "", "type": "path", "description": "ContactList ID" }, { "name": "includeImportStatus", "value": "", "type": "query", "description": "Import status" }, { "name": "includeSize", "value": "", "type": "query", "description": "Include size" } ] }, "docs": "Get a dialer contact list." }, { "info": { "name": "Update a contact list.", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v2/outbound/contactlists/:contactListId", "params": [ { "name": "contactListId", "value": "", "type": "path", "description": "ContactList ID" } ] }, "docs": "Update a contact list." }, { "info": { "name": "Delete a contact list.", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v2/outbound/contactlists/:contactListId", "params": [ { "name": "contactListId", "value": "", "type": "path", "description": "ContactList ID" } ] }, "docs": "Delete a contact list." }, { "info": { "name": "Preview the result of applying Automatic Time Zone Mapping to a contact list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/outbound/contactlists/:contactListId/timezonemappingpreview", "params": [ { "name": "contactListId", "value": "", "type": "path", "description": "ContactList ID" } ] }, "docs": "Preview the result of applying Automatic Time Zone Mapping to a contact list" }, { "info": { "name": "Get Contact List Template", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/outbound/contactlisttemplates/:contactListTemplateId", "params": [ { "name": "contactListTemplateId", "value": "", "type": "path", "description": "ContactListTemplate ID" } ] }, "docs": "Get Contact List Template" }, { "info": { "name": "Update a contact list template.", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v2/outbound/contactlisttemplates/:contactListTemplateId", "params": [ { "name": "contactListTemplateId", "value": "", "type": "path", "description": "ContactListTemplate ID" } ] }, "docs": "Update a contact list template." }, { "info": { "name": "Delete Contact List Template", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v2/outbound/contactlisttemplates/:contactListTemplateId", "params": [ { "name": "contactListTemplateId", "value": "", "type": "path", "description": "ContactListTemplate ID" } ] }, "docs": "Delete Contact List Template" }, { "info": { "name": "Query a list of contact list templates", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/outbound/contactlisttemplates", "params": [ { "name": "pageSize", "value": "", "type": "query", "description": "Page size. The max that will be returned is 100." }, { "name": "pageNumber", "value": "", "type": "query", "description": "Page number" }, { "name": "allowEmptyResult", "value": "", "type": "query", "description": "Whether to return an empty page when there are no results for that page" }, { "name": "filterType", "value": "", "type": "query", "description": "Filter type" }, { "name": "name", "value": "", "type": "query", "description": "Name" }, { "name": "sortBy", "value": "", "type": "query", "description": "Sort by" }, { "name": "sortOrder", "value": "", "type": "query", "description": "Sort order" } ] }, "docs": "Query a list of contact list templates" }, { "info": { "name": "Create Contact List Template", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/outbound/contactlisttemplates" }, "docs": "Create Contact List Template" }, { "info": { "name": "Delete multiple contact list templates.", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v2/outbound/contactlisttemplates", "params": [ { "name": "id", "value": "", "type": "query", "description": "contact list template id(s) to delete" } ] }, "docs": "Delete multiple contact list templates." }, { "info": { "name": "Add multiple contact list templates", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/outbound/contactlisttemplates/bulk/add" }, "docs": "Add multiple contact list templates" }, { "info": { "name": "Get multiple contact list templates", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/outbound/contactlisttemplates/bulk/retrieve" }, "docs": "Get multiple contact list templates" }, { "info": { "name": "Query a list of contact lists.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/outbound/contactlists", "params": [ { "name": "includeImportStatus", "value": "", "type": "query", "description": "Include import status" }, { "name": "includeSize", "value": "", "type": "query", "description": "Include size" }, { "name": "pageSize", "value": "", "type": "query", "description": "Page size. The max that will be returned is 100." }, { "name": "pageNumber", "value": "", "type": "query", "description": "Page number" }, { "name": "allowEmptyResult", "value": "", "type": "query", "description": "Whether to return an empty page when there are no results for that page" }, { "name": "filterType", "value": "", "type": "query", "description": "Filter type" }, { "name": "name", "value": "", "type": "query", "description": "Name" }, { "name": "id", "value": "", "type": "query", "description": "id" }, { "name": "divisionId", "value": "", "type": "query", "description": "Division ID(s)" }, { "name": "sortBy", "value": "", "type": "query", "description": "Sort by" }, { "name": "sortOrder", "value": "", "type": "query", "description": "Sort order" } ] }, "docs": "Any ContactList field can be used as a query parameter to filter results. Multiple values can be specified for a field, and filter type prefixes can be used inline. Example: dateCreated=greaterthan:2025-01-01T00:00:00.000Z&dateCreated=lessthan:2027-01-01T00:00:00.000Z. See https://developer.genesys.cloud/routing/outbound/filter-type for available filter types." }, { "info": { "name": "Create a contact List.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/outbound/contactlists" }, "docs": "Create a contact List." }, { "info": { "name": "Delete multiple contact lists.", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v2/outbound/contactlists", "params": [ { "name": "id", "value": "", "type": "query", "description": "contact list id(s) to delete" } ] }, "docs": "Delete multiple contact lists." }, { "info": { "name": "Generate presigned upload URL for contact list.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/outbound/contactlists/uploads" }, "docs": "Generate presigned upload URL for contact list." }, { "info": { "name": "Get a contact.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/outbound/contactlists/:contactListId/contacts/:contactId", "params": [ { "name": "contactListId", "value": "", "type": "path", "description": "Contact List ID" }, { "name": "contactId", "value": "", "type": "path", "description": "Contact ID" } ] }, "docs": "Get a contact." }, { "info": { "name": "Update a contact.", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v2/outbound/contactlists/:contactListId/contacts/:contactId", "params": [ { "name": "contactListId", "value": "", "type": "path", "description": "Contact List ID" }, { "name": "contactId", "value": "", "type": "path", "description": "Contact ID" } ] }, "docs": "Update a contact." }, { "info": { "name": "Delete a contact.", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v2/outbound/contactlists/:contactListId/contacts/:contactId", "params": [ { "name": "contactListId", "value": "", "type": "path", "description": "Contact List ID" }, { "name": "contactId", "value": "", "type": "path", "description": "Contact ID" } ] }, "docs": "Delete a contact." }, { "info": { "name": "Deletes all contacts out of a list. All outstanding recalls or rule-scheduled callbacks for non-preview campaigns configured with the contactlist will be cancelled.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/outbound/contactlists/:contactListId/clear", "params": [ { "name": "contactListId", "value": "", "type": "path", "description": "Contact List ID" } ] }, "docs": "Deletes all contacts out of a list. All outstanding recalls or rule-scheduled callbacks for non-preview campaigns configured with the contactlist will be cancelled." }, { "info": { "name": "Get bulk operation job.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/outbound/contactlists/:contactListId/contacts/bulk/jobs/:jobId", "params": [ { "name": "contactListId", "value": "", "type": "path", "description": "Contact List ID" }, { "name": "jobId", "value": "", "type": "path", "description": "Job ID" } ] }, "docs": "Get bulk operation job." }, { "info": { "name": "Get 10 most recent bulk operation jobs associated with contact list.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/outbound/contactlists/:contactListId/contacts/bulk/jobs", "params": [ { "name": "contactListId", "value": "", "type": "path", "description": "Contact List ID" } ] }, "docs": "Get 10 most recent bulk operation jobs associated with contact list." }, { "info": { "name": "Get contacts from a contact list.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/outbound/contactlists/:contactListId/contacts/bulk", "params": [ { "name": "contactListId", "value": "", "type": "path", "description": "Contact List ID" } ] }, "docs": "Get contacts from a contact list." }, { "info": { "name": "Start an async job to delete contacts using a filter.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/outbound/contactlists/:contactListId/contacts/bulk/remove", "params": [ { "name": "contactListId", "value": "", "type": "path", "description": "Contact List ID" } ] }, "docs": "Start an async job to delete contacts using a filter." }, { "info": { "name": "Start an async job to bulk edit contacts.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/outbound/contactlists/:contactListId/contacts/bulk/update", "params": [ { "name": "contactListId", "value": "", "type": "path", "description": "Contact List ID" } ] }, "docs": "Start an async job to bulk edit contacts." }, { "info": { "name": "Query contacts from a contact list.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/outbound/contactlists/:contactListId/contacts/search", "params": [ { "name": "contactListId", "value": "", "type": "path", "description": "Contact List ID" } ] }, "docs": "Query contacts from a contact list." }, { "info": { "name": "Add contacts to a contact list.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/outbound/contactlists/:contactListId/contacts", "params": [ { "name": "contactListId", "value": "", "type": "path", "description": "Contact List ID" }, { "name": "priority", "value": "", "type": "query", "description": "Contact priority. True means the contact(s) will be dialed next; false means the contact will go to the end of the contact queue." }, { "name": "clearSystemData", "value": "", "type": "query", "description": "Clear system data. True means the system columns (attempts, callable status, etc) stored on the contact will be cleared if the contact already exists; false means they won't." }, { "name": "doNotQueue", "value": "", "type": "query", "description": "Do not queue. True means that updated contacts will not have their positions in the queue altered, so contacts that have already been dialed will not be redialed. For new contacts, this parameter has no effect; False means that updated contacts will be re-queued, according to the 'priority' parameter." } ] }, "docs": "Add contacts to a contact list." }, { "info": { "name": "Delete contacts from a contact list. Only contacts that are not in use by any campaign will be deleted", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v2/outbound/contactlists/:contactListId/contacts", "params": [ { "name": "contactListId", "value": "", "type": "path", "description": "Contact List ID" }, { "name": "contactIds", "value": "", "type": "query", "description": "ContactIds to delete." } ] }, "docs": "Delete contacts from a contact list. Only contacts that are not in use by any campaign will be deleted" }, { "info": { "name": "Generate presigned upload URL for dnc list.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/outbound/dnclists/uploads" }, "docs": "Generate presigned upload URL for dnc list." }, { "info": { "name": "Add phone numbers to a Dialer DNC list.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/outbound/conversations/:conversationId/dnc", "params": [ { "name": "conversationId", "value": "", "type": "path", "description": "Conversation ID" } ] }, "docs": "Add phone numbers to a Dialer DNC list." }, { "info": { "name": "Add entries to or delete entries from a DNC list.", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v2/outbound/dnclists/:dncListId/customexclusioncolumns", "params": [ { "name": "dncListId", "value": "", "type": "path", "description": "DncList ID" } ] }, "docs": "Only Internal DNC lists may be deleted from" }, { "info": { "name": "Deletes all or expired custom exclusion column entries from a DNC list.", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v2/outbound/dnclists/:dncListId/customexclusioncolumns", "params": [ { "name": "dncListId", "value": "", "type": "path", "description": "DncList ID" }, { "name": "expiredOnly", "value": "", "type": "query", "description": "Set to true to only remove DNC entries that are expired" } ] }, "docs": "This operation is only for Internal DNC lists of custom exclusion column entries" }, { "info": { "name": "Get a basic DncList information object", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/outbound/dnclists/divisionviews/:dncListId", "params": [ { "name": "dncListId", "value": "", "type": "path", "description": "Dnclist ID" }, { "name": "includeImportStatus", "value": "", "type": "query", "description": "Include import status" }, { "name": "includeSize", "value": "", "type": "query", "description": "Include size" } ] }, "docs": "This returns a simplified version of a DncList, consisting of the name, division, import status, and size." }, { "info": { "name": "Query a list of simplified dnc list objects.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/outbound/dnclists/divisionviews", "params": [ { "name": "includeImportStatus", "value": "", "type": "query", "description": "Include import status" }, { "name": "includeSize", "value": "", "type": "query", "description": "Include size" }, { "name": "pageSize", "value": "", "type": "query", "description": "Page size. The max that will be returned is 100." }, { "name": "pageNumber", "value": "", "type": "query", "description": "Page number" }, { "name": "filterType", "value": "", "type": "query", "description": "Filter type" }, { "name": "name", "value": "", "type": "query", "description": "Name" }, { "name": "dncSourceType", "value": "", "type": "query", "description": "DncSourceType" }, { "name": "id", "value": "", "type": "query", "description": "id" }, { "name": "sortBy", "value": "", "type": "query", "description": "Sort by" }, { "name": "sortOrder", "value": "", "type": "query", "description": "Sort order" } ] }, "docs": "This return a simplified version of dnc lists, consisting of the name, division, import status, and size." }, { "info": { "name": "Add email addresses to a DNC list.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/outbound/dnclists/:dncListId/emailaddresses", "params": [ { "name": "dncListId", "value": "", "type": "path", "description": "DncList ID" } ] }, "docs": "Only Internal DNC lists may be appended to" }, { "info": { "name": "Add emails to or Delete emails from a DNC list.", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v2/outbound/dnclists/:dncListId/emailaddresses", "params": [ { "name": "dncListId", "value": "", "type": "path", "description": "DncList ID" } ] }, "docs": "Only Internal DNC lists may be added to or deleted from" }, { "info": { "name": "Deletes all or expired email addresses from a DNC list.", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v2/outbound/dnclists/:dncListId/emailaddresses", "params": [ { "name": "dncListId", "value": "", "type": "path", "description": "DncList ID" }, { "name": "expiredOnly", "value": "", "type": "query", "description": "Set to true to only remove DNC entries that are expired" } ] }, "docs": "This operation is Only for Internal DNC lists of email addresses" }, { "info": { "name": "Get the URI of a DNC list export.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/outbound/dnclists/:dncListId/export", "params": [ { "name": "dncListId", "value": "", "type": "path", "description": "DncList ID" }, { "name": "download", "value": "", "type": "query", "description": "Redirect to download uri" } ] }, "docs": "Get the URI of a DNC list export." }, { "info": { "name": "Initiate the export of a dnc list.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/outbound/dnclists/:dncListId/export", "params": [ { "name": "dncListId", "value": "", "type": "path", "description": "DncList ID" } ] }, "docs": "Returns 200 if received OK." }, { "info": { "name": "Get dialer dncList import status.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/outbound/dnclists/:dncListId/importstatus", "params": [ { "name": "dncListId", "value": "", "type": "path", "description": "DncList ID" } ] }, "docs": "Get dialer dncList import status." }, { "info": { "name": "Add phone numbers to a DNC list.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/outbound/dnclists/:dncListId/phonenumbers", "params": [ { "name": "dncListId", "value": "", "type": "path", "description": "DncList ID" }, { "name": "expirationDateTime", "value": "", "type": "query", "description": "Expiration date for DNC phone numbers in yyyy-MM-ddTHH:mmZ format" } ] }, "docs": "Only Internal DNC lists may be appended to" }, { "info": { "name": "Add numbers to or delete numbers from a DNC list.", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v2/outbound/dnclists/:dncListId/phonenumbers", "params": [ { "name": "dncListId", "value": "", "type": "path", "description": "DncList ID" } ] }, "docs": "Only Internal DNC lists may be added to deleted from" }, { "info": { "name": "Deletes all or expired phone numbers from a DNC list.", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v2/outbound/dnclists/:dncListId/phonenumbers", "params": [ { "name": "dncListId", "value": "", "type": "path", "description": "DncList ID" }, { "name": "expiredOnly", "value": "", "type": "query", "description": "Set to true to only remove DNC entries that are expired" } ] }, "docs": "This operation is Only for Internal DNC lists of phone numbers" }, { "info": { "name": "Get dialer DNC list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/outbound/dnclists/:dncListId", "params": [ { "name": "dncListId", "value": "", "type": "path", "description": "DncList ID" }, { "name": "includeImportStatus", "value": "", "type": "query", "description": "Import status" }, { "name": "includeSize", "value": "", "type": "query", "description": "Include size" } ] }, "docs": "Get dialer DNC list" }, { "info": { "name": "Update dialer DNC list", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v2/outbound/dnclists/:dncListId", "params": [ { "name": "dncListId", "value": "", "type": "path", "description": "DncList ID" } ] }, "docs": "Update dialer DNC list" }, { "info": { "name": "Delete dialer DNC list", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v2/outbound/dnclists/:dncListId", "params": [ { "name": "dncListId", "value": "", "type": "path", "description": "DncList ID" } ] }, "docs": "Delete dialer DNC list" }, { "info": { "name": "Add entries to or delete entries from a DNC list.", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v2/outbound/dnclists/:dncListId/whatsappnumbers", "params": [ { "name": "dncListId", "value": "", "type": "path", "description": "DncList ID" } ] }, "docs": "Only Internal DNC lists may be deleted from" }, { "info": { "name": "Deletes all or expired whatsApp numbers from a DNC list.", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v2/outbound/dnclists/:dncListId/whatsappnumbers", "params": [ { "name": "dncListId", "value": "", "type": "path", "description": "DncList ID" }, { "name": "expiredOnly", "value": "", "type": "query", "description": "Set to true to only remove DNC whatsApp numbers that are expired" } ] }, "docs": "This operation is only for Internal DNC lists of whatsApp numbers" }, { "info": { "name": "Query dialer DNC lists", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/outbound/dnclists", "params": [ { "name": "includeImportStatus", "value": "", "type": "query", "description": "Import status" }, { "name": "includeSize", "value": "", "type": "query", "description": "Include size" }, { "name": "pageSize", "value": "", "type": "query", "description": "Page size. The max that will be returned is 100." }, { "name": "pageNumber", "value": "", "type": "query", "description": "Page number" }, { "name": "allowEmptyResult", "value": "", "type": "query", "description": "Whether to return an empty page when there are no results for that page" }, { "name": "filterType", "value": "", "type": "query", "description": "Filter type" }, { "name": "name", "value": "", "type": "query", "description": "Name" }, { "name": "dncSourceType", "value": "", "type": "query", "description": "DncSourceType" }, { "name": "divisionId", "value": "", "type": "query", "description": "Division ID(s)" }, { "name": "sortBy", "value": "", "type": "query", "description": "Sort by" }, { "name": "sortOrder", "value": "", "type": "query", "description": "Sort order" } ] }, "docs": "Query dialer DNC lists" }, { "info": { "name": "Create dialer DNC list", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/outbound/dnclists" }, "docs": "Create dialer DNC list" }, { "info": { "name": "Get Dialer Event", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/outbound/events/:eventId", "params": [ { "name": "eventId", "value": "", "type": "path", "description": "Event Log ID" } ] }, "docs": "Get Dialer Event" }, { "info": { "name": "Query Event Logs", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/outbound/events", "params": [ { "name": "pageSize", "value": "", "type": "query", "description": "Page size" }, { "name": "pageNumber", "value": "", "type": "query", "description": "Page number" }, { "name": "filterType", "value": "", "type": "query", "description": "Filter type" }, { "name": "category", "value": "", "type": "query", "description": "Category" }, { "name": "level", "value": "", "type": "query", "description": "Level" }, { "name": "sortBy", "value": "", "type": "query", "description": "Sort by" }, { "name": "sortOrder", "value": "", "type": "query", "description": "Sort order" } ] }, "docs": "Query Event Logs" }, { "info": { "name": "Delete multiple file specification templates.", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v2/outbound/filespecificationtemplates/bulk", "params": [ { "name": "id", "value": "", "type": "query", "description": "File Specification template id(s) to delete" } ] }, "docs": "Delete multiple file specification templates." }, { "info": { "name": "Query File Specification Templates", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/outbound/filespecificationtemplates", "params": [ { "name": "pageSize", "value": "", "type": "query", "description": "Page size. The max that will be returned is 100." }, { "name": "pageNumber", "value": "", "type": "query", "description": "Page number" }, { "name": "allowEmptyResult", "value": "", "type": "query", "description": "Whether to return an empty page when there are no results for that page" }, { "name": "filterType", "value": "", "type": "query", "description": "Filter type" }, { "name": "name", "value": "", "type": "query", "description": "Name" }, { "name": "sortBy", "value": "", "type": "query", "description": "Sort by" }, { "name": "sortOrder", "value": "", "type": "query", "description": "Sort order" } ] }, "docs": "Query File Specification Templates" }, { "info": { "name": "Create File Specification Template", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/outbound/filespecificationtemplates" }, "docs": "Create File Specification Template" }, { "info": { "name": "Get File Specification Template", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/outbound/filespecificationtemplates/:fileSpecificationTemplateId", "params": [ { "name": "fileSpecificationTemplateId", "value": "", "type": "path", "description": "File Specification Template ID" } ] }, "docs": "Get File Specification Template" }, { "info": { "name": "Update File Specification Template", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v2/outbound/filespecificationtemplates/:fileSpecificationTemplateId", "params": [ { "name": "fileSpecificationTemplateId", "value": "", "type": "path", "description": "File Specification Template ID" } ] }, "docs": "Update File Specification Template" }, { "info": { "name": "Delete File Specification Template", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v2/outbound/filespecificationtemplates/:fileSpecificationTemplateId", "params": [ { "name": "fileSpecificationTemplateId", "value": "", "type": "path", "description": "File Specification Template ID" } ] }, "docs": "Delete File Specification Template" }, { "info": { "name": "Get the import status for an import template.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/outbound/importtemplates/:importTemplateId/importstatus", "params": [ { "name": "importTemplateId", "value": "", "type": "path", "description": "importTemplateId" }, { "name": "listNamePrefix", "value": "", "type": "query", "description": "listNamePrefix" } ] }, "docs": "Get the import status for an import template." }, { "info": { "name": "Get Import Template", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/outbound/importtemplates/:importTemplateId", "params": [ { "name": "importTemplateId", "value": "", "type": "path", "description": "Import Template ID" }, { "name": "includeImportStatus", "value": "", "type": "query", "description": "Import status" } ] }, "docs": "Get Import Template" }, { "info": { "name": "Update Import Template", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v2/outbound/importtemplates/:importTemplateId", "params": [ { "name": "importTemplateId", "value": "", "type": "path", "description": "Import Template ID" } ] }, "docs": "Update Import Template" }, { "info": { "name": "Delete Import Template", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v2/outbound/importtemplates/:importTemplateId", "params": [ { "name": "importTemplateId", "value": "", "type": "path", "description": "Import Template ID" } ] }, "docs": "Delete Import Template" }, { "info": { "name": "Query Import Templates", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/outbound/importtemplates", "params": [ { "name": "includeImportStatus", "value": "", "type": "query", "description": "Import status" }, { "name": "pageSize", "value": "", "type": "query", "description": "Page size. The max that will be returned is 100." }, { "name": "pageNumber", "value": "", "type": "query", "description": "Page number" }, { "name": "allowEmptyResult", "value": "", "type": "query", "description": "Whether to return an empty page when there are no results for that page" }, { "name": "filterType", "value": "", "type": "query", "description": "Filter type" }, { "name": "name", "value": "", "type": "query", "description": "Name" }, { "name": "sortBy", "value": "", "type": "query", "description": "Sort by" }, { "name": "sortOrder", "value": "", "type": "query", "description": "Sort order" }, { "name": "contactListTemplateId", "value": "", "type": "query", "description": "Contact List Template ID" } ] }, "docs": "Query Import Templates" }, { "info": { "name": "Create Import Template", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/outbound/importtemplates" }, "docs": "Create Import Template" }, { "info": { "name": "Delete multiple import templates.", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v2/outbound/importtemplates", "params": [ { "name": "id", "value": "", "type": "query", "description": "import template id(s) to delete" } ] }, "docs": "Delete multiple import templates." }, { "info": { "name": "Add multiple import templates", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/outbound/importtemplates/bulk/add" }, "docs": "Add multiple import templates" }, { "info": { "name": "Get progress for a list of messaging campaigns", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/outbound/messagingcampaigns/progress" }, "docs": "Get progress for a list of messaging campaigns" }, { "info": { "name": "Get the outbound settings for this organization", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/outbound/settings" }, "docs": "Get the outbound settings for this organization" }, { "info": { "name": "Update the outbound settings for this organization", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v2/outbound/settings", "params": [ { "name": "useMaxCallsPerAgentDecimal", "value": "", "type": "query", "description": "Use maxCallsPerAgent with decimal precision" } ] }, "docs": "Update the outbound settings for this organization" }, { "info": { "name": "Get a Rule Set by ID.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/outbound/rulesets/:ruleSetId", "params": [ { "name": "ruleSetId", "value": "", "type": "path", "description": "Rule Set ID" } ] }, "docs": "Get a Rule Set by ID." }, { "info": { "name": "Update a Rule Set.", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v2/outbound/rulesets/:ruleSetId", "params": [ { "name": "ruleSetId", "value": "", "type": "path", "description": "Rule Set ID" } ] }, "docs": "Update a Rule Set." }, { "info": { "name": "Delete a Rule Set.", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v2/outbound/rulesets/:ruleSetId", "params": [ { "name": "ruleSetId", "value": "", "type": "path", "description": "Rule Set ID" } ] }, "docs": "Delete a Rule Set." }, { "info": { "name": "Query a list of Rule Sets.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/outbound/rulesets", "params": [ { "name": "pageSize", "value": "", "type": "query", "description": "Page size. The max that will be returned is 100." }, { "name": "pageNumber", "value": "", "type": "query", "description": "Page number" }, { "name": "allowEmptyResult", "value": "", "type": "query", "description": "Whether to return an empty page when there are no results for that page" }, { "name": "filterType", "value": "", "type": "query", "description": "Filter type" }, { "name": "name", "value": "", "type": "query", "description": "Name" }, { "name": "sortBy", "value": "", "type": "query", "description": "Sort by" }, { "name": "sortOrder", "value": "", "type": "query", "description": "Sort order" } ] }, "docs": "Query a list of Rule Sets." }, { "info": { "name": "Create a Rule Set.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/outbound/rulesets" }, "docs": "Create a Rule Set." }, { "info": { "name": "Get a dialer campaign sequence.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/outbound/sequences/:sequenceId", "params": [ { "name": "sequenceId", "value": "", "type": "path", "description": "Campaign Sequence ID" } ] }, "docs": "Get a dialer campaign sequence." }, { "info": { "name": "Update a new campaign sequence.", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v2/outbound/sequences/:sequenceId", "params": [ { "name": "sequenceId", "value": "", "type": "path", "description": "Campaign Sequence ID" } ] }, "docs": "Update a new campaign sequence." }, { "info": { "name": "Delete a dialer campaign sequence.", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v2/outbound/sequences/:sequenceId", "params": [ { "name": "sequenceId", "value": "", "type": "path", "description": "Campaign Sequence ID" } ] }, "docs": "Delete a dialer campaign sequence." }, { "info": { "name": "Get a dialer sequence schedule.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/outbound/schedules/sequences/:sequenceId", "params": [ { "name": "sequenceId", "value": "", "type": "path", "description": "Sequence ID" } ] }, "docs": "Get a dialer sequence schedule." }, { "info": { "name": "Update a new sequence schedule.", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v2/outbound/schedules/sequences/:sequenceId", "params": [ { "name": "sequenceId", "value": "", "type": "path", "description": "Sequence ID" } ] }, "docs": "Update a new sequence schedule." }, { "info": { "name": "Delete a dialer sequence schedule.", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v2/outbound/schedules/sequences/:sequenceId", "params": [ { "name": "sequenceId", "value": "", "type": "path", "description": "Sequence ID" } ] }, "docs": "Delete a dialer sequence schedule." }, { "info": { "name": "Query for a list of dialer sequence schedules.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/outbound/schedules/sequences" }, "docs": "Query for a list of dialer sequence schedules." }, { "info": { "name": "Query a list of dialer campaign sequences.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/outbound/sequences", "params": [ { "name": "pageSize", "value": "", "type": "query", "description": "Page size. The max that will be returned is 100." }, { "name": "pageNumber", "value": "", "type": "query", "description": "Page number" }, { "name": "allowEmptyResult", "value": "", "type": "query", "description": "Whether to return an empty page when there are no results for that page" }, { "name": "filterType", "value": "", "type": "query", "description": "Filter type" }, { "name": "name", "value": "", "type": "query", "description": "Name" }, { "name": "sortBy", "value": "", "type": "query", "description": "Sort by" }, { "name": "sortOrder", "value": "", "type": "query", "description": "Sort order" } ] }, "docs": "Query a list of dialer campaign sequences." }, { "info": { "name": "Create a new campaign sequence.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/outbound/sequences" }, "docs": "Create a new campaign sequence." }, { "info": { "name": "Get the Dialer wrap up code mapping.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/outbound/wrapupcodemappings" }, "docs": "Get the Dialer wrap up code mapping." }, { "info": { "name": "Update the Dialer wrap up code mapping.", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v2/outbound/wrapupcodemappings" }, "docs": "Update the Dialer wrap up code mapping." }, { "info": { "name": "Get diagnostic summary for a single campaign", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/outbound/diagnostics/campaigns/:campaignId/summary", "params": [ { "name": "campaignId", "value": "", "type": "path", "description": "Campaign ID" }, { "name": "start", "value": "", "type": "query", "description": "Start datetime (ISO 8601 or Unix epoch)" }, { "name": "end", "value": "", "type": "query", "description": "End datetime (ISO 8601 or Unix epoch)" } ] }, "docs": "Get diagnostic summary for a single campaign" }, { "info": { "name": "Get an Outbound Digital Rule Set", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/outbound/digitalrulesets/:digitalRuleSetId", "params": [ { "name": "digitalRuleSetId", "value": "", "type": "path", "description": "The Digital Rule Set ID" } ] }, "docs": "Get an Outbound Digital Rule Set" }, { "info": { "name": "Update an Outbound Digital Rule Set", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v2/outbound/digitalrulesets/:digitalRuleSetId", "params": [ { "name": "digitalRuleSetId", "value": "", "type": "path", "description": "The Digital Rule Set ID" } ] }, "docs": "Update an Outbound Digital Rule Set" }, { "info": { "name": "Delete an Outbound Digital Rule Set", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v2/outbound/digitalrulesets/:digitalRuleSetId", "params": [ { "name": "digitalRuleSetId", "value": "", "type": "path", "description": "The Digital Rule Set ID" } ] }, "docs": "Delete an Outbound Digital Rule Set" }, { "info": { "name": "Query a list of Outbound Digital Rule Sets", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/outbound/digitalrulesets", "params": [ { "name": "pageSize", "value": "", "type": "query", "description": "Page size. The max that will be returned is 100." }, { "name": "pageNumber", "value": "", "type": "query", "description": "Page number" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The direction to sort" }, { "name": "name", "value": "", "type": "query", "description": "Name" }, { "name": "id", "value": "", "type": "query", "description": "A list of digital rule set ids to bulk fetch" } ] }, "docs": "Query a list of Outbound Digital Rule Sets" }, { "info": { "name": "Create an Outbound Digital Rule Set", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/outbound/digitalrulesets" }, "docs": "Create an Outbound Digital Rule Set" }, { "info": { "name": "Get a basic Messaging Campaign information object", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/outbound/messagingcampaigns/divisionviews/:messagingCampaignId", "params": [ { "name": "messagingCampaignId", "value": "", "type": "path", "description": "The Messaging Campaign ID" } ] }, "docs": "This returns a simplified version of a Messaging Campaign, consisting of id, name, and division." }, { "info": { "name": "Query a list of basic Messaging Campaign information objects", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/outbound/messagingcampaigns/divisionviews", "params": [ { "name": "pageSize", "value": "", "type": "query", "description": "Page size. The max that will be returned is 100." }, { "name": "pageNumber", "value": "", "type": "query", "description": "Page number" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The direction to sort" }, { "name": "name", "value": "", "type": "query", "description": "Name" }, { "name": "type", "value": "", "type": "query", "description": "Campaign Type" }, { "name": "id", "value": "", "type": "query", "description": "id" }, { "name": "senderSmsPhoneNumber", "value": "", "type": "query", "description": "Sender SMS Phone Number" }, { "name": "contentTemplateId", "value": "", "type": "query", "description": "Content template ID" }, { "name": "campaignStatus", "value": "", "type": "query", "description": "Campaign Status" } ] }, "docs": "This returns a listing of simplified Messaging Campaigns, each consisting of id, name, and division." }, { "info": { "name": "Get an Outbound Messaging Campaign", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/outbound/messagingcampaigns/:messagingCampaignId", "params": [ { "name": "messagingCampaignId", "value": "", "type": "path", "description": "The Messaging Campaign ID" } ] }, "docs": "Get an Outbound Messaging Campaign" }, { "info": { "name": "Update an Outbound Messaging Campaign", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v2/outbound/messagingcampaigns/:messagingCampaignId", "params": [ { "name": "messagingCampaignId", "value": "", "type": "path", "description": "The Messaging Campaign ID" } ] }, "docs": "Update an Outbound Messaging Campaign" }, { "info": { "name": "Delete an Outbound Messaging Campaign", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v2/outbound/messagingcampaigns/:messagingCampaignId", "params": [ { "name": "messagingCampaignId", "value": "", "type": "path", "description": "The Messaging Campaign ID" } ] }, "docs": "Delete an Outbound Messaging Campaign" }, { "info": { "name": "Get messaging campaign's progress", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/outbound/messagingcampaigns/:messagingCampaignId/progress", "params": [ { "name": "messagingCampaignId", "value": "", "type": "path", "description": "The Messaging Campaign ID" } ] }, "docs": "Get messaging campaign's progress" }, { "info": { "name": "Reset messaging campaign progress and recycle the messaging campaign", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v2/outbound/messagingcampaigns/:messagingCampaignId/progress", "params": [ { "name": "messagingCampaignId", "value": "", "type": "path", "description": "The Messaging Campaign ID" } ] }, "docs": "Documented permissions are applicable based on campaign type." }, { "info": { "name": "Get messaging campaign diagnostics", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/outbound/messagingcampaigns/:messagingCampaignId/diagnostics", "params": [ { "name": "messagingCampaignId", "value": "", "type": "path", "description": "The Messaging Campaign ID" } ] }, "docs": "Get messaging campaign diagnostics" }, { "info": { "name": "Start the campaign", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/outbound/messagingcampaigns/:messagingCampaignId/start", "params": [ { "name": "messagingCampaignId", "value": "", "type": "path", "description": "The Messaging Campaign ID" } ] }, "docs": "Documented permissions are applicable based on campaign type." }, { "info": { "name": "Stop the campaign", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/outbound/messagingcampaigns/:messagingCampaignId/stop", "params": [ { "name": "messagingCampaignId", "value": "", "type": "path", "description": "The Messaging Campaign ID" } ] }, "docs": "Documented permissions are applicable based on campaign type." }, { "info": { "name": "Query a list of Messaging Campaigns", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/outbound/messagingcampaigns", "params": [ { "name": "pageSize", "value": "", "type": "query", "description": "Page size. The max that will be returned is 100." }, { "name": "pageNumber", "value": "", "type": "query", "description": "Page number" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The direction to sort" }, { "name": "name", "value": "", "type": "query", "description": "Name" }, { "name": "contactListId", "value": "", "type": "query", "description": "Contact List ID" }, { "name": "divisionId", "value": "", "type": "query", "description": "Division ID(s)" }, { "name": "type", "value": "", "type": "query", "description": "Campaign Type" }, { "name": "senderSmsPhoneNumber", "value": "", "type": "query", "description": "Sender SMS Phone Number" }, { "name": "id", "value": "", "type": "query", "description": "A list of messaging campaign ids to bulk fetch" }, { "name": "contentTemplateId", "value": "", "type": "query", "description": "Content template ID" }, { "name": "campaignStatus", "value": "", "type": "query", "description": "Campaign Status" }, { "name": "ruleSetIds", "value": "", "type": "query", "description": "Ruleset ID(s)" } ] }, "docs": "Query a list of Messaging Campaigns" }, { "info": { "name": "Create a Messaging Campaign", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/outbound/messagingcampaigns" }, "docs": "Create a Messaging Campaign" }, { "info": { "name": "Get an email campaign schedule.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/outbound/schedules/emailcampaigns/:emailCampaignId", "params": [ { "name": "emailCampaignId", "value": "", "type": "path", "description": "Email Campaign ID" } ] }, "docs": "Get an email campaign schedule." }, { "info": { "name": "Update an email campaign schedule.", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v2/outbound/schedules/emailcampaigns/:emailCampaignId", "params": [ { "name": "emailCampaignId", "value": "", "type": "path", "description": "Email Campaign ID" } ] }, "docs": "Update an email campaign schedule." }, { "info": { "name": "Delete an email campaign schedule.", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v2/outbound/schedules/emailcampaigns/:emailCampaignId", "params": [ { "name": "emailCampaignId", "value": "", "type": "path", "description": "Email Campaign ID" } ] }, "docs": "Delete an email campaign schedule." }, { "info": { "name": "Query for a list of email campaign schedules.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/outbound/schedules/emailcampaigns" }, "docs": "Query for a list of email campaign schedules." }, { "info": { "name": "Get a messaging campaign schedule.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/outbound/schedules/messagingcampaigns/:messagingCampaignId", "params": [ { "name": "messagingCampaignId", "value": "", "type": "path", "description": "Messaging Campaign ID" } ] }, "docs": "Get a messaging campaign schedule." }, { "info": { "name": "Update a new messaging campaign schedule.", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v2/outbound/schedules/messagingcampaigns/:messagingCampaignId", "params": [ { "name": "messagingCampaignId", "value": "", "type": "path", "description": "Messaging Campaign ID" } ] }, "docs": "Update a new messaging campaign schedule." }, { "info": { "name": "Delete a messaging campaign schedule.", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v2/outbound/schedules/messagingcampaigns/:messagingCampaignId", "params": [ { "name": "messagingCampaignId", "value": "", "type": "path", "description": "Messaging Campaign ID" } ] }, "docs": "Delete a messaging campaign schedule." }, { "info": { "name": "Query for a list of messaging campaign schedules.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/outbound/schedules/messagingcampaigns" }, "docs": "Query for a list of messaging campaign schedules." }, { "info": { "name": "Get a WhatsApp campaign schedule.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/outbound/schedules/whatsappcampaigns/:whatsAppCampaignId", "params": [ { "name": "whatsAppCampaignId", "value": "", "type": "path", "description": "WhatsApp Campaign ID" } ] }, "docs": "Get a WhatsApp campaign schedule." }, { "info": { "name": "Update a WhatsApp campaign schedule.", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v2/outbound/schedules/whatsappcampaigns/:whatsAppCampaignId", "params": [ { "name": "whatsAppCampaignId", "value": "", "type": "path", "description": "WhatsApp Campaign ID" } ] }, "docs": "Update a WhatsApp campaign schedule." }, { "info": { "name": "Delete a WhatsApp campaign schedule.", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v2/outbound/schedules/whatsappcampaigns/:whatsAppCampaignId", "params": [ { "name": "whatsAppCampaignId", "value": "", "type": "path", "description": "WhatsApp Campaign ID" } ] }, "docs": "Delete a WhatsApp campaign schedule." }, { "info": { "name": "Query for a list of WhatsApp campaign schedules.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/outbound/schedules/whatsappcampaigns" }, "docs": "Query for a list of WhatsApp campaign schedules." } ] } ], "bundled": true }