Promo Numbers
=============

Advertiser Campaign and Affiliate Campaign Promo Numbers
""""""""""""""""""""""""""""""""""""""""""""""""""""""""

The API provides the ability to manage promo numbers for a given campaign.
Promo numbers are uniquely identified by the phone number itself and these numbers are always generated by the Invoca platform.
Therefore, the operations on the promo numbers interface are not idempotent.
When you POST a promo number, we return the promo_number in the response body. This capability is JSON‐only.

.. list-table::
  :widths: 11 34 40
  :header-rows: 1
  :class: parameters

  * - Property
    - Type
    - Value

  * - description
    - string (required)
    - Arbitrary description

  * - media_type
    - string (required)
    - one of:

      “Online: Content / Review Site”

      “Online: Discount / Coupon Site”

      “Online: Display”

      “Online: Email”

      “Online: Rewards / Incentive”

      “Online: Lead Form / Co Reg”

      “Online: Search”

      “Online: Social Media”

      “Online: Software”

      “Online: Other”

      “Mobile: Apps”

      “Mobile: Display”

      “Mobile: Search”

      “Mobile: SMS”

      “Mobile: Other”

      “Offline: Business Publication”

      “Offline: Call Center”

      “Offline: Direct Mail”

      “Offline: Directory”

      “Offline: Newspaper”

      “Offline: In­Call Ad”

      “Offline: Magazine”

      “Offline: Outdoor”

      “Offline: Radio”

      “Offline: TV”

      “Offline: Other”

  * - local_center
    - hash
    - Requires one of the following

      City & State required together

      A filled field determines the center to start looking for local numbers at.

      **“tn_prefix”**: an npa

      **“zipcode”**: a valid zipcode

      **“city”**: a valid city

      **“state”**: a valid state

  * - tn_prefix_whitelist
    - array of strings
    - an array of stringified limiters on the boundaries of where to look for local numbers given as npas (ex. [“805”, “212”])


Endpoint:

``https://invoca.net/api/@@NETWORK_API_VERSION/<network_id>/advertisers/<advertiser_id_from_network>/advertiser_campaigns/<advertiser_campaign_id_from_network>/promo_numbers/<promo_number>.json``

.. api_endpoint::
   :verb: GET
   :path: /promo_numbers
   :description: Get all Promo Numbers
   :page: get_promo_numbers

.. api_endpoint::
   :verb: GET
   :path: /promo_numbers/&lt;promo_number&gt;
   :description: Read a Promo Number
   :page: get_promo_number

.. api_endpoint::
   :verb: POST
   :path: /promo_numbers.json
   :description: Create an Advertiser/Affiliate Promo Number
   :page: post_promo_numbers

.. api_endpoint::
   :verb: PUT
   :path: /promo_numbers/&lt;promo_number&gt;
   :description: Update a Campaign Promo Number
   :page: put_promo_number

.. api_endpoint::
   :verb: DELETE
   :path: /promo_numbers/&lt;promo_number&gt;
   :description: Delete a Campaign Promo Number
   :page: delete_promo_number