Update a branding

Update an existing branding resource

 

PUT  puthttps://:account.api-us1.com/api/3/brandings/id

• cURL

curl --request PUT \
  --url https:///:account.api-us1.com/api/3/brandings/1

• Node

var request = require("request");

var options = { method: 'PUT',
  url: 'https:///:account.api-us1.com/api/3/brandings/1' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

• Ruby

require 'uri'
require 'net/http'

url = URI("https:///:account.api-us1.com/api/3/brandings/1")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)

response = http.request(request)
puts response.read_body

• JavaScript

var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("PUT", "https:///:account.api-us1.com/api/3/brandings/1");

xhr.send(data);

• Python

import requests

url = "https:///:account.api-us1.com/api/3/brandings/1"

response = requests.request("PUT", url)

print(response.text)

 

 200 OK

{
	"branding": {
		"groupid": "3",
		"siteName": "ActiveCampaign Email Marketing",
		"siteLogo": "http:\/\/mysite.com\/logo.jpg",
		"siteLogoSmall": "http:\/\/mysite.com\/logo_small.jpg",
		"headerTextValue": "my custom text header",
		"headerHtmlValue": "<p>my custom HTML header<\/p>",
		"footerTextValue": "my custom text footer",
		"footerHtmlValue": "<p>my custom HTML footer<\/p>",
		"copyright": "1",
		"version": "1",
		"license": "1",
		"links": "1",
		"help": "1",
		"adminTemplateHtm": "",
		"adminTemplateCss": "",
		"publicTemplateHtm": "",
		"publicTemplateCss": "",
		"favicon": null,
		"id": "1"
	}
}

PATH PARAMS

 

id                                    REQUIRED

int32                               Branding ID

 

BODY PARAMS

branding

object

 

branding.groupid

int32                               The group ID. This value will always be 3.

 

branding.siteName

string                              Title of software. Example: 'ActiveCampaign Email Marketing'

 

branding.siteLogo

string

 

branding.siteLogoSmall

string                              URL of small logo. Small logos appear in the header of the admin panel.

 

branding.headerTextValue

string                              Content of non-removable header. Example: text header content

 

branding.headerHtmlValue

string                              Content of non-removable header. Example:

                                      header content here

branding.footerTextValue

string                              Content of non-removeable footer. Example: text footer content

 

branding.footerHtmlValue

string                              Content of non-removeable footer. Example:

                                      footer content here

branding.copyright

boolean                          unknown

 

branding.version

boolean                          unknown

 

branding.license

boolean                          unknown

 

branding.links

boolean                          External links. To enable (which is the default) exclude this parameter entirely.

To disable (remove our branding), just pass this parameter with any value.

branding.help

string

 

branding.adminTemplateHtm

string                              The actual HTML template (ONLY AVAILABLE FOR CERTAIN PLANS)

 

branding.adminTemplateCss

string                               The actual CSS. Example: test color: green; (ONLY AVAILABLE FOR CERTAIN PLANS)

 

branding.publicTemplateHtm

string                               The actual HTML template (ONLY AVAILABLE FOR CERTAIN PLANS)

 

branding.publicTemplateCss

string                               The actual CSS. Example: test color: green; (ONLY AVAILABLE FOR CERTAIN PLANS)

 

branding.favicon

string                               URL of the favicon.