Add a header

POST /api/1/header

1	POST /api/1/header

Add a new header to your account.

Parameters

Name	Parameter Type	Allow Multiple	Required/ Optional	Data Type	Description
Authorization:	Header	False	Required	String (Bearer {access token})	Pass the authentication token that was granted when you authorized access.
HTML	form	False	Required	String	Valid HTML for header. Any graphical elements must be referenced using an absolute path.
text	form	False	Optional	String	Text version of header for use as alternative.
title	form	False	Required	String	Header title to use as display title in Act-On user interface.

Request

Following is an example HTTP request:

HTTP

POST /api/1/header/ HTTP/1.1
Host: restapi.actonsoftware.com
Authorization: Bearer 8133c46115e9cee3952edc193a53a3f5
Cache-Control: no-cache
Content-Type: application/x-www-form-urlencoded

title=alternate-header&amp;html=%22%3Cp%3E%3Cspan+style%3D%5C%22font-size%3A+14pt%3B%5C%22%3ETest+Header%3C%2Fspan%3E%3C%2Fp%3E%5C%5C%5Cn%3Cp%3E%3Ca+href%3D%5C%22http%3A%2F%2Fci51.actonsoftware.com%2Facton%2Frif%2F%7B%7BEnv.AccountId%7D%7D%2F%7B%7BEnv.MsgId%7D%7D%2F-%2F%7B%7BEnv.RecId%7D%7D%2F%7B%7BEnv.SrcId%7D%7D%2Fzout%5C%22+target%3D%5C%22_blank%5C%22%3EClick+here+to+opt+out%3C%2Fa%3E%3C%2Fp%3E%22&amp;text=%22Test+Header%5C%5C%5Cn%5C%5C%5Cn+Click+here+to+opt+out%5C%5C%5Cnhttp%3A%2F%2Fci51.actonsoftware.com%2Facton%2Frif%2F%7B%7BEnv.AccountId%7D%7D%2F%7B%7BEnv.MsgId%7D%7D%2F-%2F%7B%7BEnv.RecId%7D%7D%2F%7B%7BEnv.SrcId%7D%7D%2Fzout%5C%5C%5Cn%5C%5C%5Cn%22

POST /api/1/header/ HTTP/1.1

Host: restapi.actonsoftware.com

Authorization: Bearer 8133c46115e9cee3952edc193a53a3f5

Cache-Control: no-cache

Content-Type: application/x-www-form-urlencoded

title=alternate-header&html=%22%3Cp%3E%3Cspan+style%3D%5C%22font-size%3A+14pt%3B%5C%22%3ETest+Header%3C%2Fspan%3E%3C%2Fp%3E%5C%5C%5Cn%3Cp%3E%3Ca+href%3D%5C%22http%3A%2F%2Fci51.actonsoftware.com%2Facton%2Frif%2F%7B%7BEnv.AccountId%7D%7D%2F%7B%7BEnv.MsgId%7D%7D%2F-%2F%7B%7BEnv.RecId%7D%7D%2F%7B%7BEnv.SrcId%7D%7D%2Fzout%5C%22+target%3D%5C%22_blank%5C%22%3EClick+here+to+opt+out%3C%2Fa%3E%3C%2Fp%3E%22&text=%22Test+Header%5C%5C%5Cn%5C%5C%5Cn+Click+here+to+opt+out%5C%5C%5Cnhttp%3A%2F%2Fci51.actonsoftware.com%2Facton%2Frif%2F%7B%7BEnv.AccountId%7D%7D%2F%7B%7BEnv.MsgId%7D%7D%2F-%2F%7B%7BEnv.RecId%7D%7D%2F%7B%7BEnv.SrcId%7D%7D%2Fzout%5C%5C%5Cn%5C%5C%5Cn%22

curl

Following is an example curl request:

curl -X POST -H "Authorization: Bearer 8133c46115e9cee3952edc193a53a3f5" -H "Cache-Control: no-cache" -H "Content-Type: application/x-www-form-urlencoded" -d 'title=alternate-header&amp;amp;html=%22%3Cp%3E%3Cspan+style%3D%5C%22font-size%3A+14pt%3B%5C%22%3ETest+Header%3C%2Fspan%3E%3C%2Fp%3E%5C%5C%5Cn%3Cp%3E%3Ca+href%3D%5C%22http%3A%2F%2Fci51.actonsoftware.com%2Facton%2Frif%2F%7B%7BEnv.AccountId%7D%7D%2F%7B%7BEnv.MsgId%7D%7D%2F-%2F%7B%7BEnv.RecId%7D%7D%2F%7B%7BEnv.SrcId%7D%7D%2Fzout%5C%22+target%3D%5C%22_blank%5C%22%3EClick+here+to+opt+out%3C%2Fa%3E%3C%2Fp%3E%22&amp;text=%22Test+Header%5C%5C%5Cn%5C%5C%5Cn+Click+here+to+opt+out%5C%5C%5Cnhttp%3A%2F%2Fci51.actonsoftware.com%2Facton%2Frif%2F%7B%7BEnv.AccountId%7D%7D%2F%7B%7BEnv.MsgId%7D%7D%2F-%2F%7B%7BEnv.RecId%7D%7D%2F%7B%7BEnv.SrcId%7D%7D%2Fzout%5C%5C%5Cn%5C%5C%5Cn%22' 'https://restapi.actonsoftware.com/api/1/header/'

curl -X POST -H "Authorization: Bearer 8133c46115e9cee3952edc193a53a3f5" -H "Cache-Control: no-cache" -H "Content-Type: application/x-www-form-urlencoded" -d 'title=alternate-header&amp;html=%22%3Cp%3E%3Cspan+style%3D%5C%22font-size%3A+14pt%3B%5C%22%3ETest+Header%3C%2Fspan%3E%3C%2Fp%3E%5C%5C%5Cn%3Cp%3E%3Ca+href%3D%5C%22http%3A%2F%2Fci51.actonsoftware.com%2Facton%2Frif%2F%7B%7BEnv.AccountId%7D%7D%2F%7B%7BEnv.MsgId%7D%7D%2F-%2F%7B%7BEnv.RecId%7D%7D%2F%7B%7BEnv.SrcId%7D%7D%2Fzout%5C%22+target%3D%5C%22_blank%5C%22%3EClick+here+to+opt+out%3C%2Fa%3E%3C%2Fp%3E%22&text=%22Test+Header%5C%5C%5Cn%5C%5C%5Cn+Click+here+to+opt+out%5C%5C%5Cnhttp%3A%2F%2Fci51.actonsoftware.com%2Facton%2Frif%2F%7B%7BEnv.AccountId%7D%7D%2F%7B%7BEnv.MsgId%7D%7D%2F-%2F%7B%7BEnv.RecId%7D%7D%2F%7B%7BEnv.SrcId%7D%7D%2Fzout%5C%5C%5Cn%5C%5C%5Cn%22' 'https://restapi.actonsoftware.com/api/1/header/'

Response

A successful request results in an HTTP 200 response with a JSON object like the following:

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

{

"status": "Success",

"message": "Header added.",

"id": "2"

}