POST /v1/entity/advertiser/create

NOTE: This method is not accessible to users on Starter Plan API keys. Please contact us if you want premium access to our service

HTTP Method: POST

Path:  /v1/entity/advertiser/create

Authentication: API Key required, User ID required

Description: Make an entity an advertiser for a given publisher 

Parameters:

 

Parameter Type Mandatory Description Example
api_key string yes the user API key b66qw3edr56thhg
_user_id string yes The user user_id ax34er6tt65edr
publisher_id string yes The id of the “publisher” of the advert w4wer445t5gpo688
entity_id string yes The entity ID where advertiser object will be inserted. 45679321234
max_tags integer yes number of searchable tags allowed 5
max_locations integer yes number of searchable locations allowed 5
expiry_date date yes expiry date of the advert 2014-05-06
language string no ISO-compatible language code. Default is en en, es
is_national boolean no whether the advert is national coverage. Default is FALSE  
tags string no comma-separated list of searchable tags boiler repair, boiler installation
locations string no comma-separated list of valid location ids 145678, 123476
reseller_ref string yes A sales reference in the seller's systems (to help with reporting) JP123
reseller_agent_id string yes Reference to the identity of reseller agent Johnny Sales

 

Sample Success Response:

{
    "success": true,
    "msg": "ok",
    "data": {
        "ok": true,
        "id": "379275323781120",
        "rev": "29-f8659797282cbbfffa92c20731486e38"
    }
}

 

Error Responses:

If an attempt is made to insert an advert where the entity is already an advertiser for that publisher, the following error will be returned:

{
  "success": false,
  "msg": "This entity is already an advertiser for that publisher. Cannot insert advertiser object. Please refer to the list of available publishers",
  "data": {}
}

version 10 as of 6 years ago by Unknown

Docs Navigation