Create Widgets

POST /widgets
Copied
Arrow
                https://api.ocamba.com/v2/adex/widgets

Creates a new Widget object

Request Body Schema
Arrow
Name
Description
contentstring
The widget content. This is the place where you can put HTML content with replacable fragments(macros). Where HTML page is rendered, placeholders are replaced with real macro values.
macros[ widget-macro ]
The array of macro objects.
Macro
Name
Description
namestring
The macro name.


Example: TITLE
requirednumber (int)
Acceptable values are - 0/1.


Example: 1
typestring
At this time only text macros are supported.


Example: text
namestringrequired
The widget name.


Example: My first widget
Response status codes
Arrow
201 - Created
Arrow
note
1 There is a limited number of macros you can add to the content. These macros are - LANDING_URL, IMPRESSION_URL, TITLE, IMAGE, ICON, DESCRIPTION, DESCRIPTION2, SPONSORED, RATING, PHONE, ADDRESS, DOWNLOADS, PRICE, SALE_PRICE, LIKES, ADVERTISER_DOMAIN, DISPLAY_URL, CALL_TO_ACTION, IMPRESSION_PIXEL.
2 The macros can be repeated inside the content field.
3 Content field may save up to 20000 characters.
4 All macros that are located in the content field should also be inserted in the macros array.
Request examples
Copied
Arrow
200 Arrow
  • 200
{
  "name": "example name"
}
Response examples
Copied
Arrow
201 Arrow
  • 201
{
  "id": "206",
  "company_id": "3813298",
  "name": "example name",
  "type": "user-defined"
}