Set pdf branding
title: Set the PDF branding¶
Change the calling issuer's PDF branding. Fields passed replace the saved ones, omitted fields are kept, an empty string clears one. Nothing is saved if anything is invalid. The logo is sent as base64 (PNG or JPEG, at most 1 MB and 2000x2000 px) and is re-encoded as PNG.
Alcance (scope): issuers:write · Características: Destructiva, Idempotente
Parámetros¶
| Parámetro | Tipo | Obligatorio | Descripción |
|---|---|---|---|
accent_color |
string | No | One color, six hex digits like #05668d. Headings, table headers and rules are drawn from it. |
phone |
string | No | At most 30 characters. |
email |
string | No | |
website |
string | No | Must start with https:// |
footer |
string | No | Plain text, at most 500 characters and 8 lines. |
logo_base64 |
string | No | The logo image, base64 encoded (a data: URI is accepted). |
remove_logo |
boolean | No | Delete the stored logo. Not with logo_base64. |
issuer |
string | Sí | Id of the issuer the call acts for, from list_issuers. |
Esquema de entrada (JSON Schema)¶
{
"type": "object",
"properties": {
"accent_color": {
"type": "string",
"description": "One color, six hex digits like #05668d. Headings, table headers and rules are drawn from it."
},
"phone": {
"type": "string",
"description": "At most 30 characters."
},
"email": {
"type": "string"
},
"website": {
"type": "string",
"description": "Must start with https://"
},
"footer": {
"type": "string",
"description": "Plain text, at most 500 characters and 8 lines."
},
"logo_base64": {
"type": "string",
"description": "The logo image, base64 encoded (a data: URI is accepted)."
},
"remove_logo": {
"type": "boolean",
"description": "Delete the stored logo. Not with logo_base64."
},
"issuer": {
"type": "string",
"format": "uuid",
"description": "Id of the issuer the call acts for, from list_issuers."
}
},
"required": [
"issuer"
]
}