{
  "opencollection": "1.0.0",
  "info": {
    "name": "Telnyx Access Tokens Campaign API",
    "version": "2.0.0"
  },
  "request": {
    "auth": {
      "type": "bearer",
      "token": "{{bearerToken}}"
    }
  },
  "items": [
    {
      "info": {
        "name": "Campaign",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List Campaigns",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.telnyx.com/v2/10dlc/campaign",
            "params": [
              {
                "name": "brandId",
                "value": "",
                "type": "query"
              },
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "The 1-indexed page number to get. The default value is `1`."
              },
              {
                "name": "recordsPerPage",
                "value": "",
                "type": "query",
                "description": "The amount of records per page, limited to between 1 and 500 inclusive. The default value is `10`."
              },
              {
                "name": "sort",
                "value": "-assignedPhoneNumbersCount",
                "type": "query",
                "description": "Specifies the sort order for results. If not given, results are sorted by createdAt in descending order."
              }
            ]
          },
          "docs": "Retrieve a list of campaigns associated with a supplied `brandId`."
        },
        {
          "info": {
            "name": "Accept Shared Campaign",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.telnyx.com/v2/10dlc/campaign/acceptSharing/:campaignId",
            "params": [
              {
                "name": "campaignId",
                "value": "",
                "type": "path",
                "description": "TCR's ID for the campaign to import"
              }
            ]
          },
          "docs": "Manually accept a campaign shared with Telnyx"
        },
        {
          "info": {
            "name": "Get Campaign Cost",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.telnyx.com/v2/10dlc/campaign/usecase/cost",
            "params": [
              {
                "name": "usecase",
                "value": "",
                "type": "query"
              }
            ]
          },
          "docs": "Get Campaign Cost"
        },
        {
          "info": {
            "name": "Get campaign",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.telnyx.com/v2/10dlc/campaign/:campaignId",
            "params": [
              {
                "name": "campaignId",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Retrieve campaign details by `campaignId`."
        },
        {
          "info": {
            "name": "Update campaign",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api.telnyx.com/v2/10dlc/campaign/:campaignId",
            "params": [
              {
                "name": "campaignId",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Update a campaign's properties by `campaignId`. **Please note:** only sample messages are editable."
        },
        {
          "info": {
            "name": "Deactivate campaign",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.telnyx.com/v2/10dlc/campaign/:campaignId",
            "params": [
              {
                "name": "campaignId",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Terminate a campaign. Note that once deactivated, a campaign cannot be restored."
        },
        {
          "info": {
            "name": "Submit campaign appeal for manual review",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.telnyx.com/v2/10dlc/campaign/:campaignId/appeal",
            "params": [
              {
                "name": "campaignId",
                "value": "",
                "type": "path",
                "description": "The Telnyx campaign identifier"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Submits an appeal for rejected native campaigns in TELNYX_FAILED or MNO_REJECTED status. The appeal is recorded for manual compliance team review and the campaign status is reset to TCR_ACCEPTED. Note: Appeal forwarding is handled manually to allow proper review before incurring upstream charges."
        },
        {
          "info": {
            "name": "Get Campaign Mno Metadata",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.telnyx.com/v2/10dlc/campaign/:campaignId/mnoMetadata",
            "params": [
              {
                "name": "campaignId",
                "value": "",
                "type": "path",
                "description": "ID of the campaign in question"
              }
            ]
          },
          "docs": "Get the campaign metadata for each MNO it was submitted to."
        },
        {
          "info": {
            "name": "Get campaign operation status",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.telnyx.com/v2/10dlc/campaign/:campaignId/operationStatus",
            "params": [
              {
                "name": "campaignId",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Retrieve campaign's operation status at MNO level."
        },
        {
          "info": {
            "name": "Get OSR campaign attributes",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.telnyx.com/v2/10dlc/campaign/:campaignId/osr/attributes",
            "params": [
              {
                "name": "campaignId",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Get OSR campaign attributes"
        },
        {
          "info": {
            "name": "Get Sharing Status",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.telnyx.com/v2/10dlc/campaign/:campaignId/sharing",
            "params": [
              {
                "name": "campaignId",
                "value": "",
                "type": "path",
                "description": "ID of the campaign in question"
              }
            ]
          },
          "docs": "Get Sharing Status"
        },
        {
          "info": {
            "name": "Submit Campaign",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.telnyx.com/v2/10dlc/campaignBuilder",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Before creating a campaign, use the [Qualify By Usecase endpoint](https://developers.telnyx.com/api-reference/campaign/qualify-by-usecase) to ensure that the brand you want to assign a new campaign to is qualified for the desired use case of that campaign. **Please note:** After campaign creation, you'll only be able to edit the campaign's sample messages. Creating a campaign will entail an upfront, non-refundable three month's cost that will depend on the campaign's use case ([see 10DLC Costs s"
        },
        {
          "info": {
            "name": "Qualify By Usecase",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.telnyx.com/v2/10dlc/campaignBuilder/brand/:brandId/usecase/:usecase",
            "params": [
              {
                "name": "usecase",
                "value": "",
                "type": "path"
              },
              {
                "name": "brandId",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "This endpoint allows you to see whether or not the supplied brand is suitable for your desired campaign use case."
        }
      ]
    }
  ],
  "bundled": true
}