Update a footer

PUT api/1/footer/{id}

1	PUT api/1/footer/{id}

Update an existing footer in the 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.
footerid	Path	False	Required	String	ID of the footer you want to update.
html	Form	False	Required	String	The HTML to use for replacing the existing footer.
text	Form	False	Optional	String	The text for text-only footer.
title	Form	False	Optional	String	The footer title to show in the UI.

Request

Following is an example HTTP request:

HTTP

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

title=alternate-footer&amp;html=%22%3Cp%3E%3Cspan+style%3D%5C%22font-size%3A+14pt%3B%5C%22%3ETest+Footer%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+Footer%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

PUT /api/1/footer/3 HTTP/1.1

Host: restapi.actonsoftware.com

Authorization: Bearer 8133c46115e9cee3952edc193a53a3f5

Cache-Control: no-cache

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

title=alternate-footer&html=%22%3Cp%3E%3Cspan+style%3D%5C%22font-size%3A+14pt%3B%5C%22%3ETest+Footer%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+Footer%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 PUT -H "Authorization: Bearer 8133c46115e9cee3952edc193a53a3f5" -H "Cache-Control: no-cache" -H "Content-Type: application/x-www-form-urlencoded" -d 'title=alternate-footer&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+Footer%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/footer/3'

curl -X PUT -H "Authorization: Bearer 8133c46115e9cee3952edc193a53a3f5" -H "Cache-Control: no-cache" -H "Content-Type: application/x-www-form-urlencoded" -d 'title=alternate-footer&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+Footer%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/footer/3'

Response

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

{
    "status": "success",
    "message": "The footer has been updated",
    "id":   "3"
}</pre>
<h3>Java code example</h3>
<pre>package content;

import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.JsonNode;
import com.mashape.unirest.http.Unirest;
import com.mashape.unirest.http.exceptions.UnirestException;
import org.json.JSONObject;
import util.Utility;

import java.io.File;

public class PutLogoExample
{
    static String BASE_URL         = "https://restapi.actonsoftware.com/api/1/";
    public static void main(String[] args)
        {
            putFooterUsingFile();
        }

      public static void putLogoUsingFile()
        {
        try
            {
            String id = "&lt;Provide Footer id&gt;";
            String testapiputfootertitle = "footer title":
            String testapiputfooterhtml = "footer html";
            String testapiputfootertxt = "footer txt";
            String accessToken  = Utility.getAccessToken();
            Unirest.setHttpClient(Utility.makeClient());
            Unirest.setDefaultHeader("Authorization", "Bearer " + accessToken);
            HttpResponse&lt;String&gt; jsonResponse = Unirest.put(BASE_URL + "footer/"+id)
                    .header("accept", "application/json")
                    .field("title", testapiputfootertitle)
                    .field("html", testapiputfooterhtml)
                    .field("text", testapiputfootertxt)
                    .asString();

            if(jsonResponse.getCode()==200){
                String jsonResponseBody = jsonResponse.getBody();
                System.out.println("The response body is : "+jsonResponseBody );
            }else {
                System.out.println("The response is : "+ jsonResponse);
            }
            }
        catch (UnirestException e)
            {
            e.printStackTrace();
            }
        }

}

{

"status": "success",

"message": "The footer has been updated",

"id": "3"

}</pre>

<h3>Java code example</h3>

<pre>package content;

import com.mashape.unirest.http.HttpResponse;

import com.mashape.unirest.http.JsonNode;

import com.mashape.unirest.http.Unirest;

import com.mashape.unirest.http.exceptions.UnirestException;

import org.json.JSONObject;

import util.Utility;

import java.io.File;

public class PutLogoExample

{

static String BASE_URL = "https://restapi.actonsoftware.com/api/1/";

public static void main(String[] args)

{

putFooterUsingFile();

}

public static void putLogoUsingFile()

{

try

{

String id = "<Provide Footer id>";

String testapiputfootertitle = "footer title":

String testapiputfooterhtml = "footer html";

String testapiputfootertxt = "footer txt";

String accessToken = Utility.getAccessToken();

Unirest.setHttpClient(Utility.makeClient());

Unirest.setDefaultHeader("Authorization", "Bearer " + accessToken);

HttpResponse<String> jsonResponse = Unirest.put(BASE_URL + "footer/"+id)

.header("accept", "application/json")

.field("title", testapiputfootertitle)

.field("html", testapiputfooterhtml)

.field("text", testapiputfootertxt)

.asString();

if(jsonResponse.getCode()==200){

String jsonResponseBody = jsonResponse.getBody();

System.out.println("The response body is : "+jsonResponseBody );

}else {

System.out.println("The response is : "+ jsonResponse);

}

catch (UnirestException e)

{

e.printStackTrace();

}