- Previous: PUT /v1/entityserve
- Up: Central Index API
- Next: POST /v1/entity/advertiser/create
POST /v1/entity/advertiser/cancel
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/cancel
Authentication: API Key required, User ID required
Description: Cancel (expire) an existing advertiser
Parameters:
Parameter | Type | Mandatory | Description | Example |
api_key | string | yes | The user API key | k5er678uyrt54er |
_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 |
reseller_ref | string | yes | A sales reference in the seller's systems (to help with reporting) | JP123 |
reseller_agent_id | string | yes | Rference to the identity of reseller agent | Johnny Sales |
Sample Success Response:
{ "success": true, "msg": "ok", "data": { "ok": true, "id": "379275323781120", "rev": "29-f8659797282cbbfffa92c20731486e38" } }
- Previous: PUT /v1/entityserve
- Up: Central Index API
- Next: POST /v1/entity/advertiser/create
Docs Navigation
- Introduction
- Getting Started
- Using IODocs
- Responses
- Creating a sample request
- Sample Libraries
- Central Index API
- What data do we store in an entity?
- GET /v1/advertiser/updated
- GET /v1/autocomplete/category
- GET /v1/autocomplete/keyword
- GET /v1/autocomplete/location
- GET /v1/entity
- GET /v1/entity/advertisers
- GET /v1/entity/advertisers/inventorycheck
- GET /v1/entity/by_supplier_id
- GET /v1/entity/search/keyword/bynearest
- GET /v1/entity/search/what
- GET /v1/entity/search/what/bylocation
- GET /v1/entity/search/what/byboundingbox
- GET /v1/entity/search/what/bynearest
- GET /v1/entity/search/who
- GET /v1/entity/search/who/bylocation
- GET /v1/entity/search/who/byboundingbox
- GET /v1/entity/search/who/bynearest
- GET /v1/location
- GET /v1/location/context
- GET /v1/lookup/category
- GET /v1/match/byphone
- GET /v1/stats/entity/by_date
- GET /v1/syndication_log/by_entity_id
- GET /v1/token/add
- GET /v1/token/report
- GET /v1/token/claim
- GET /v1/token/message
- GET /v1/tools/docs
- GET /v1/user/by_email
- PUT /v1/business
- PUT /v1/business/json
- PUT /v1/entityserve
- POST /v1/entity/advertiser/cancel
- POST /v1/entity/advertiser/create
- POST /v1/entity/advertiser/renew
- POST /v1/entity/advertiser/upsell
- POST /v1/entity/category
- POST /v1/entity/claim
- POST /entity/claim/cancel
- POST /v1/entity/claim/reseller
- POST /v1/entity/description
- POST /v1/entity/document
- POST /v1/entity/email
- POST /v1/entity/fax
- POST /v1/entity/featured_message
- POST /v1/entity/geopoint
- POST /v1/entity/image
- POST /v1/entity/image/by_url
- POST /v1/entity/list
- POST /v1/entity/logo
- POST /v1/entity/logo/by_url
- POST /v1/entity/name
- POST /v1/entity/opening_times
- POST /v1/entity/payment_type
- POST /v1/entity/phone
- POST /v1/entity/postal_address
- POST /v1/entity/socialmedia
- POST /v1/entity/special_offer
- POST /v1/entity/tag
- POST /v1/entity/testimonial
- POST /v1/entity/video/youtube
- POST /v1/entity/website
- POST /v1/syndication/cancel
- POST /v1/syndication/create
- POST /v1/signal
- POST /v1/user
- DELETE /v1/entity/category
- DELETE /v1/entity/description
- DELETE /v1/entity/image
- DELETE /v1/entity/phone
- DELETE /v1/entity/logo
- DELETE /v1/entity/website
- syndication api