Get account branded email layout

GET

api

accounts

{account_id}

branded_email_layout

Get account branded email layout

curl --request GET \
  --url https://app.chatwoot.com/api/v1/accounts/{account_id}/branded_email_layout \
  --header 'api_access_token: <api-key>'

import requests

url = "https://app.chatwoot.com/api/v1/accounts/{account_id}/branded_email_layout"

headers = {"api_access_token": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {api_access_token: '<api-key>'}};

fetch('https://app.chatwoot.com/api/v1/accounts/{account_id}/branded_email_layout', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://app.chatwoot.com/api/v1/accounts/{account_id}/branded_email_layout",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "api_access_token: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://app.chatwoot.com/api/v1/accounts/{account_id}/branded_email_layout"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("api_access_token", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://app.chatwoot.com/api/v1/accounts/{account_id}/branded_email_layout")
  .header("api_access_token", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.chatwoot.com/api/v1/accounts/{account_id}/branded_email_layout")

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

request = Net::HTTP::Get.new(url)
request["api_access_token"] = '<api-key>'

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

{
  "branded_email_layout": "<html><body>{{ content_for_layout }}</body></html>"
}

{
  "description": "<string>",
  "errors": [
    {
      "field": "<string>",
      "message": "<string>",
      "code": "<string>"
    }
  ]
}

Authorizations

api_access_token

string

header

required

This token can be obtained by visiting the profile page or via rails console. Provides access to endpoints based on the user permissions levels. This token can be saved by an external system when user is created via API, to perform activities on behalf of the user.

Path Parameters

account_id

integer

required

The numeric ID of the account

Response

Success

branded_email_layout

string | null

Account-scoped Liquid HTML layout for branded email replies.

Example:

"<html><body>{{ content_for_layout }}</body></html>"

Update account branded email layoutUpdate or clear the account-scoped Liquid HTML layout used as the fallback for branded email replies.

Get account branded email layout

curl --request GET \
  --url https://app.chatwoot.com/api/v1/accounts/{account_id}/branded_email_layout \
  --header 'api_access_token: <api-key>'

import requests

url = "https://app.chatwoot.com/api/v1/accounts/{account_id}/branded_email_layout"

headers = {"api_access_token": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {api_access_token: '<api-key>'}};

fetch('https://app.chatwoot.com/api/v1/accounts/{account_id}/branded_email_layout', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://app.chatwoot.com/api/v1/accounts/{account_id}/branded_email_layout",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "api_access_token: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://app.chatwoot.com/api/v1/accounts/{account_id}/branded_email_layout"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("api_access_token", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://app.chatwoot.com/api/v1/accounts/{account_id}/branded_email_layout")
  .header("api_access_token", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.chatwoot.com/api/v1/accounts/{account_id}/branded_email_layout")

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

request = Net::HTTP::Get.new(url)
request["api_access_token"] = '<api-key>'

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

{
  "branded_email_layout": "<html><body>{{ content_for_layout }}</body></html>"
}

{
  "description": "<string>",
  "errors": [
    {
      "field": "<string>",
      "message": "<string>",
      "code": "<string>"
    }
  ]
}

Getting Started

Application APIs

Platform APIs

Client APIs

Other APIs

Authorizations

Path Parameters

Response