POST /v1/entity/special_offer

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/special_offer

Authentication: API Key required, User ID required

Description: upload a special offer for an entity

Parameters:

Parameter	Type	Mandatory	Description	Example
api_key	string	yes	the user API key	b66qw3edr56thhg
_user_id	string	yes	The user user_id	ax34er6tt65edr
entity_id	string	yes	The entity ID being manipulated	379275323781120
title	string	yes	Title of the special offer	"50% off all taps"
description	string	yes	Body of the special offer	"Get 50% off all our taps, while stocks last"
start_date	date	yes	Offer start date	2014-01-01
expiry_date	date	yes	Offer expiry date	2015-01-01
terms	string	no	Any terms and conditions	"While stocks last"
url	url	no	URL to the offer	http://www.boots.co.uk/special_offer.html"

Sample Success Response:

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

version 3 as of 5 years ago by Unknown

POST /v1/entity/special_offer

Docs Navigation