Add a Header

POST https://restapi.actonsoftware.com/api/1/header

This endpoint allows you to add a header to the account.

Parameters

Name Parameter
Type
Allow
Multiple
Required/
Optional
Data Type Description
Authorization: Header False Required String Insert your generated access token.
("Bearer {access token}")
HTML form False Required String Specify valid HTML for the header.
text form False Required String Specify the text version of the header.
title form False Required String Specify a title for the header

Parameter Notes

HTML

Any graphical elements must be referenced using an absolute path.

Response

{
  "status": "Success",
  "message": "Header added.",
  "id": "1"
}

 

Code Examples

cURLPython

curl -X POST https://restapi.actonsoftware.com/api/1/header/ -H "Authorization: Bearer 12345678-9abc-defg-hijk-lmnopqrs" -H "Content-Type: application/x-www-form-urlencoded" -d 'title=alternate-header' -d 'html=Example HTML HERE' -d 'text=Example TEXT Version Here'

import requests

url = "https://restapi.actonsoftware.com/api/1/header/"

payload = 'title=alternate-header&html=Example%20HTML%20HERE&text=Example%20TEXT%20Version%20Here'
headers = {
  'Authorization': 'Bearer b78d2252-8c86-3d8c-bd8e-ff62a6fc057c',
  'Content-Type': 'application/x-www-form-urlencoded'
}

response = requests.request("POST", url, headers=headers, data = payload)

print(response.text.encode('utf8'))