Get HTML widgets
/get_html_widgets
Target audience: Developers
Release version: 4.5.6
Get HTML widgets¶
Introduction¶
This endpoint returns a specified HTML widget, with or without a given title code.
URI¶
| Environment | URI |
|---|---|
| Stage | https://payway-api.stage.adeprimo.se/external/api/v5/marketing/get_html_widgets |
| Production | https://backend.worldoftulo.com/external/api/v5/marketing/get_html_widgets |
Requirements¶
Feature needs to be enabled by Adeprimo. Please contact support to enable.
| Identity | Scope |
|---|---|
| No | /external/marketing/r |
Parameters¶
| Name | Required | Type | Description |
|---|---|---|---|
| key | Yes | String | The key of the widget we should fetch |
| title_code | No | String | The title code the widget should be included in. If none is specified, we will try to find a widget with no title set. |
Curl Example¶
curl --request GET \
--url https://payway-api.stage.adeprimo.se/external/api/v5/marketing/get_html_widgets?key=my-widget \
--header 'accept: application/json' \
--header 'authorization: Bearer <access_token>'
Response¶
HTTP 200
{
"item": {
"id": "ADFADFADFADFADFADF",
"name": "My widget",
"key": "my-widget",
"code": "<html></html>",
"title_ids": []
}
}
Errors¶
This API uses the common error conventions of the Payway API