Upload Template Asset
POST/api/pdf-template-assets
Uploads a new image asset for use in templates. Send the request as multipart/form-data.
settings:writeGrant this scope to your token under Settings → Developer → Personal Access Tokens.
Authentication: Personal Access Token (sent as a Bearer token) with the settings scope (write access).
Fields:
- image (required): the image file (JPG, PNG, GIF, or WEBP, max 5 MB).
- name (optional): a display name; the reference slug is derived from it.
The response includes the generated slug and the token you place in template content.
Request
Responses
- 200
- 401
- 403
- 422
- 429
OK
Response Headers
Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.
Forbidden — the token lacks a required scope, the endpoint is not available to API tokens, or the user behind the token lacks the permission. A human must adjust the token scopes or user permissions; do not retry.
Unprocessable Entity
Response Headers
Rate limited — platform limit is 1,000 requests/min; individual tokens may carry lower limits. Honor the Retry-After header before retrying. See the Rate Limits guide.