Update report branding

Replaces report identity, footer, website, primary color, logo data and custom-domain settings.

PUT https://app.upfour.io/v1/organization/report-branding

A real request. Sending it changes data in your up4 account.

Authorization

AuthorizationA pls_ key. It stays in this browser tab. Needs organization.write.

Body

name The agency name on reports. Empty uses the Company name. footer_text Up to 240 characters. website_url An http(s) address without credentials. primary_color #RRGGBB; defaults to #294E9E.

Logo2

logo_data_url The logo as a data:image/png;base64 or data:image/jpeg;base64 URL, at most 1 MB. Empty together with logo_url removes the logo. logo_url An http(s) address of a PNG or JPEG. up4 fetches it and stores a copy; when it is set, logo_data_url is derived from it.

Custom domain3

domain Read-only: the custom domain of domain_page_id. domain_page_id A status page of the Company with a custom domain; reports are then shared on that domain. null uses up4's own address. domain_status Read-only: the state of that domain; shared links only work on it while it is active.

Sent directly from your browser to https://app.upfour.io/v1. Mutating calls get an automatic Idempotency-Key when the field is empty.

Request

Responsenot sent yet

Fill in a key and press Send request (⌘↵).
The answer appears here.

scope organization.write stable returns 200

Body

The 4 fields most calls use come first; the rest are grouped below.

application/json required 9 fields

namestring

The agency name on reports. Empty uses the Company name.

footer_textstring

Up to 240 characters.

website_urlstring

An http(s) address without credentials.

primary_colorstring

#RRGGBB; defaults to #294E9E.

Logo2 fields

logo_data_urlstring

The logo as a data:image/png;base64 or data:image/jpeg;base64 URL, at most 1 MB. Empty together with logo_url removes the logo.

logo_urlstring

An http(s) address of a PNG or JPEG. up4 fetches it and stores a copy; when it is set, logo_data_url is derived from it.

Custom domain3 fields

domainstring

Read-only: the custom domain of domain_page_id.

domain_page_iduuid · nullable

A status page of the Company with a custom domain; reports are then shared on that domain. null uses up4's own address.

domain_statusstring

Read-only: the state of that domain; shared links only work on it while it is active.

nonepending_dnsqueuedprovisioningactivefaileddisabledconflict_requires_reviewunavailable

Returns

A successful request returns 200 with application/json.

Response fields 1 top-level fields

Field Type Description

data ReportBrandingSettingsResponse

ReportBrandingSettingsResponse · 9 fields

Field	Type	Description
`domain_page_id`	uuid · nullable	A status page of the Company with a custom domain; reports are then shared on that domain. null uses up4's own address.
`footer_text`	string	Up to 240 characters.
`logo_data_url`	string	The logo as a data:image/png;base64 or data:image/jpeg;base64 URL, at most 1 MB. Empty together with logo_url removes the logo.
`logo_url`	string	An http(s) address of a PNG or JPEG. up4 fetches it and stores a copy; when it is set, logo_data_url is derived from it.
`name`	string	The agency name on reports. Empty uses the Company name.
`primary_color`	string	#RRGGBB; defaults to #294E9E.
`website_url`	string	An http(s) address without credentials.
`domain`	string	Read-only: the custom domain of domain_page_id.
`domain_status`	string one of`nonepending_dnsqueuedprovisioningactivefaileddisabledconflict_requires_reviewunavailable`	Read-only: the state of that domain; shared links only work on it while it is active.

Errors

Only the errors this operation can return. Every error uses the same envelope.

Status	Code	Meaning
400	`bad_request`	The request is malformed or fails validation.
400	`file_empty`	The uploaded file is empty. When: Uploading a logo or image with no content. Fix: Upload a file that has content.
413	`file_too_large`	The uploaded file is over the size limit. When: Uploading a logo or image larger than details.max_bytes. Fix: Reduce the file size and upload again.
400	`file_type_unsupported`	The file's type is not accepted for this upload. When: Uploading a file whose type is not one of the formats the operation accepts; details.formats lists them. Fix: Upload a file in one of details.formats.
400	`image_dimensions_too_large`	The image has more pixels than allowed. When: Uploading an image with more pixels than details.max_pixels. Fix: Scale the image down and upload it again.
400	`image_invalid`	The file is not a readable image. When: Uploading a file with an image type that cannot be decoded. Fix: Export the image again and upload the new file.
400	`logo_fetch_failed`	The logo could not be fetched from the address given. When: Importing a client logo from a URL that cannot be reached or that does not return an acceptable image. Fix: Check the URL, or upload the logo file instead.
403	`permission_denied`	The credentials do not permit this action.
400	`svg_unsafe`	The SVG contains content that is not allowed. When: Uploading an SVG that contains a script, a foreignObject, a javascript: URL, an event-handler attribute or an external href. Fix: Remove those parts from the SVG, or upload a PNG or JPEG.
400	`upload_invalid`	The upload could not be read as a multipart form. When: A body that is not a valid multipart form, or whose file cannot be parsed. Fix: Send a well-formed multipart/form-data request.
400	`upload_no_file`	The multipart request has no file part. When: An upload request without a file field. Fix: Send the file as multipart/form-data in the field the operation names.

Every call can also return unauthorized (401), rate_limit_exceeded (429) or internal_error (500 / 502). See Responses and errors.

curl -s -X PUT "https://app.upfour.io/v1/organization/report-branding" \ -H "Authorization: Bearer $UP4_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "footer_text": "Prepared by Acme GmbH", "name": "Acme GmbH", "primary_color": "#2547b0", "website_url": "https://example.com" }'

const res = await fetch("https://app.upfour.io/v1/organization/report-branding", { method: "PUT", headers: { Authorization: `Bearer ${process.env.UP4_API_KEY}`, "Content-Type": "application/json", }, body: JSON.stringify({ footer_text: "Prepared by Acme GmbH", name: "Acme GmbH", primary_color: "#2547b0", website_url: "https://example.com", }), }); console.log(res.status, await res.json());

import os import requests res = requests.put( "https://app.upfour.io/v1/organization/report-branding", headers={"Authorization": f"Bearer {os.environ['UP4_API_KEY']}"}, json={ "footer_text": "Prepared by Acme GmbH", "name": "Acme GmbH", "primary_color": "#2547b0", "website_url": "https://example.com", }, ) print(res.status_code, res.json())

package main import ( "fmt" "io" "net/http" "os" "strings" ) func main() { payload := strings.NewReader(`{ "footer_text": "Prepared by Acme GmbH", "name": "Acme GmbH", "primary_color": "#2547b0", "website_url": "https://example.com" }`) req, _ := http.NewRequest("PUT", "https://app.upfour.io/v1/organization/report-branding", payload) req.Header.Set("Authorization", "Bearer "+os.Getenv("UP4_API_KEY")) req.Header.Set("Content-Type", "application/json") res, err := http.DefaultClient.Do(req) if err != nil { panic(err) } defer res.Body.Close() out, _ := io.ReadAll(res.Body) fmt.Println(res.StatusCode, string(out)) }

<?php $payload = <<<'JSON' { "footer_text": "Prepared by Acme GmbH", "name": "Acme GmbH", "primary_color": "#2547b0", "website_url": "https://example.com" } JSON; $ch = curl_init("https://app.upfour.io/v1/organization/report-branding"); curl_setopt_array($ch, [ CURLOPT_CUSTOMREQUEST => "PUT", CURLOPT_RETURNTRANSFER => true, CURLOPT_HTTPHEADER => [ "Authorization: Bearer " . getenv("UP4_API_KEY"), "Content-Type: application/json", ], CURLOPT_POSTFIELDS => $payload, ]); $response = curl_exec($ch); echo curl_getinfo($ch, CURLINFO_RESPONSE_CODE), " ", $response, "\n"; curl_close($ch);

{ "data": { "domain_page_id": null, "footer_text": "Prepared by Acme GmbH", "logo_data_url": "", "logo_url": "", "name": "Acme GmbH", "primary_color": "#2547b0", "website_url": "https://example.com" } }