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.

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: InCall Ad”

“Offline: Magazine”

“Offline: Outdoor”

“Offline: Radio”

“Offline: TV”

“Offline: Other”

Endpoint:

https://invoca.net/api/2015-12-09/<network_id>/advertisers/<advertiser_id_from_network>/advertiser_campaigns/<advertiser_campaign_id_from_network>/promo_numbers/<promo_number>.json

GET

/promo_numbers

Get all Promo Numbers

Examples

Read all Advertiser Campaign Promo Numbers as an array

Endpoint:

https://invoca.net/api/2015-12-09/<network_id>/advertisers/<advertiser_id_from_network>/advertiser_campaigns/<advertiser_campaign_id_from_network>/promo_numbers.json

Format: application/json

Response Code: 200

Response Body:

{
  "media_type": "Online: Display",
  "description": "Halloween Promo Number 1",
  "promo_number": "8001234567"
}

Read all Affiliate Campaign Promo Numbers as an array

Endpoint:

https://invoca.net/api/2015-12-09/<network_id>/advertisers/<advertiser_id_from_network>/advertiser_campaigns/<advertiser_campaign_id_from_network>/affiliates/<affiliate_id_from_network>/affiliate_campaigns/promo_numbers.json

Format: application/json

Response Code: 200

Response Body:

{
  "media_type": "Online: Display",
  "description": "Halloween Promo Number 1",
  "promo_number": "8001234567"
}

GET

/promo_numbers/<promo_number>

Read a Promo Number

Examples

Read a specific Advertiser Campaign Promo Number

Endpoint:

https://invoca.net/api/2015-12-09/<network_id>/advertisers/<advertiser_id_from_network>/advertiser_campaigns/<advertiser_campaign_id_from_network>/promo_numbers/<promo_number>.json

Format: application/json

Response Code: 200

Response Body:

{
  "media_type": "Online: Display",
  "description": "Halloween Promo Number 1",
  "promo_number": "8001234567"
}

Read a specific Affiliate Campaign Promo Number

Endpoint:

https://invoca.net/api/2015-12-09/<network_id>/advertisers/<advertiser_id_from_network>/advertiser_campaigns/<advertiser_campaign_id_from_network>/affiliates/<affiliate_id_from_network>/affiliate_campaigns/promo_numbers/<promo_number>.json

Format: application/json

Response Code: 200

Response Body:

{
  "media_type": "Online: Display",
  "description": "Halloween Promo Number 1",
  "promo_number": "8001234567"
}

POST

/promo_numbers.json

Create an Advertiser/Affiliate Promo Number

Examples

Create an Advertiser Campaign Promo Number

Endpoint:

https://invoca.net/api/2015-12-09/<network_id>/advertisers/<advertiser_id_from_network>/advertiser_campaigns/<advertiser_campaign_id_from_network>/promo_numbers.json

Format: application/json

Request Body:

{
  "description": "Halloween Promo Number 1",
  "media_type": "Online: Display"
}

Response Code: 201

Response Body:

{
  "media_type": "Online: Display",
  "promo_number": "8777657743",
  "description": "Halloween Promo Number 1"
}

Create an Affiliate Campaign Promo Number

Endpoint:

https://invoca.net/api/2015-12-09/<network_id>/advertisers/<advertiser_id_from_network>/advertiser_campaigns/<advertiser_campaign_id_from_network>/affiliates/<affiliate_id_from_network>/affiliate_campaigns/promo_numbers.json

Format: application/json

Request Body:

{
  "description": "Halloween Promo Number 1",
  "media_type": "Online: Display"
}

Response Code: 201

Response Body:

{
  "media_type": "Online: Display",
  "promo_number": "8777657743",
  "description": "Halloween Promo Number 1"
}

PUT

/promo_numbers/<promo_number>

Update a Campaign Promo Number

Examples

Update an Advertiser Campaign Promo Number

Endpoint:

https://invoca.net/api/2015-12-09/<network_id>/advertisers/<advertiser_id_from_network>/advertiser_campaigns/<advertiser_campaign_id_from_network>/promo_numbers/<promo_number>.json

Format: application/json

Request Body:

{
  "description": "Halloween Promo Number 1 Updated",
  "media_type": "Online: Display"
}

Response Code: 200

Response Body:

{
}

Update Affiliate Campaign Promo Number

Endpoint:

https://invoca.net/api/2015-12-09/<network_id>/advertisers/<advertiser_id_from_network>/advertiser_campaigns/<advertiser_campaign_id_from_network>/affiliates/<affiliate_id_from_network>/affiliate_campaigns/promo_numbers/<promo_number>.json

Format: application/json

Request Body:

{
  "description": "Halloween Promo Number 1 Updated",
  "media_type": "Online: Display"
}

Response Code: 200

Response Body:

{
}

DELETE

/promo_numbers/<promo_number>

Delete a Campaign Promo Number

Examples

Delete an Advertiser Campaign Promo Number

Endpoint:

https://invoca.net/api/2015-12-09/<network_id>/advertisers/<advertiser_id_from_network>/advertiser_campaigns/<advertiser_campaign_id_from_network>/promo_numbers/<promo_number>.json

Format: application/json

Response Code: 200

Response Body:

{
}

Delete an Affiliate Campaign Promo Number

Endpoint:

https://invoca.net/api/2015-12-09/<network_id>/advertisers/<advertiser_id_from_network>/advertiser_campaigns/<advertiser_campaign_id_from_network>/affiliates/<affiliate_id_from_network>/affiliate_campaigns/promo_numbers/<promo_number>.json

Format: application/json

Response Code: 200

Response Body:

{
}