Prembly
GuidesAPI Reference
Background ChecksReportsSave report customization (PATCH alias) PATCH

Deprecated

PATCH
/api/v1/api/bgc/report-customization/

Deprecated alias. Identical to POST on this path — despite the verb it is a full upsert, not a partial update. Use POST /report-customization/ instead.

Authorization

ApiKeyAuth
X-API-Key<token>

In: header

Request Body

TypeScript Definitions

Use the request body type in TypeScript.

Serializer for creating and updating Report Customization.

Response Body

application/json

curl -X PATCH "https://example.com/api/v1/api/bgc/report-customization/" \  -H "Content-Type: application/json" \  -d '{}'
{  "data": {    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "organisation": "a4b97354-4e56-4723-bc0e-1f22b5fcbed6",    "logo": "http://example.com",    "company_name": "string",    "primary_color": "string",    "secondary_color": "string",    "accent_color": "string",    "text_color": "string",    "header_text": "string",    "footer_text": "string",    "show_company_address": true,    "show_company_contact": true,    "show_watermark": true,    "watermark_text": "string",    "show_verification_summary": true,    "show_check_details": true,    "show_candidate_info": true,    "show_timestamps": true,    "introduction_message": "string",    "disclaimer_message": "string",    "template_style": "modern",    "font_family": "string",    "font_size": "string",    "custom_css": "string",    "additional_settings": null,    "effective_logo": "string",    "effective_company_name": "string",    "color_scheme": "string",    "visibility_settings": "string",    "is_active": true,    "created_at": "2019-08-24T14:15:22Z",    "updated_at": "2019-08-24T14:15:22Z"  },  "status": true,  "message": "Request successful.",  "errors": {},  "meta": {    "timestamp": "2019-08-24T14:15:22Z",    "version": "v1",    "request_id": "string"  },  "pagination": {    "page": 0,    "page_size": 0,    "total_pages": 0,    "total_items": 0  }}
Response Codes & Statuses: Prembly API responses include custom response_code values (e.g., 00 Success, 01 Not Found, 02 Unavailable).
View Response Codes Guide
Prembly Slack Community

Join our developer Slack channel for real-time integration support, engineering updates, and direct Q&A with the Prembly team.

Join Slack Channel

Save report customization POST

Saves your report branding and layout, creating the settings if none exist and replacing them if they do. Applies to reports generated from now on; reports already produced are unchanged. `PUT` and `PATCH` on this path do exactly the same thing and are kept only for existing callers.

Save report customization (PUT alias) PUT

Deprecated alias. Identical to `POST` on this path — it calls the same handler. Use `POST /report-customization/` instead.