API by router
Branding
GET
HTTPBearerheader
AuthorizationBearer <token>X-Api-Key?string|nullSuccessful Response
application/json- response
Full branding config returned to the frontend.
accent_color*Accent Colorbackground_color*Background Colorbody_font*Body Fontbusiness_name*Business Namecreated_at*Created AtFormat
date-timecustom_domain?string|nulldescription?string|nulldomain_verified*Domain Verifiededge_instance_id?|nullfavicon_url?string|nullheading_font*Heading Fontid*IdFormat
uuidlogo_url?string|nullmono_font*Mono Fontog_image_url?string|nullpowered_by_enabled*Powered By Enabledprimary_color*Primary Colorsocial_linkedin?string|nullsocial_twitter?string|nullsocial_website?string|nullssl_error?string|nullssl_status?Ssl StatusDefault
"none"support_email?string|nullsurface_color*Surface Colortagline?string|nulltenant_id*Tenant IdFormat
uuidtext_color*Text Colorupdated_at*Updated AtFormat
date-timecurl -X GET 'https://example.com/v1/brand'Example Response
{ "accent_color": "string", "background_color": "string", "body_font": "string", "business_name": "string", "created_at": "2019-08-24T14:15:22Z", "custom_domain": "string", "description": "string", "domain_verified": true, "edge_instance_id": "6552900c-5e1f-46a9-8b32-a26e16ab8ecd", "favicon_url": "string", "heading_font": "string", "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "logo_url": "string", "mono_font": "string", "og_image_url": "string", "powered_by_enabled": true, "primary_color": "string", "social_linkedin": "string", "social_twitter": "string", "social_website": "string", "ssl_error": "string", "ssl_status": "none", "support_email": "string", "surface_color": "string", "tagline": "string", "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0", "text_color": "string", "updated_at": "2019-08-24T14:15:22Z"}PUT
HTTPBearerheader
AuthorizationBearer <token>X-Api-Key?string|nullapplication/json- body
Partial update - only send the fields you want to change.
"I'll have what she's having." - When Harry Met Sally (what every reseller says when they see a well-branded competitor)
accent_color?|nullbackground_color?|nullbody_font?|nullbusiness_name?|nullcustom_domain?|nulldescription?string|nulledge_instance_id?|nullfavicon_url?string|nullheading_font?|nulllogo_url?string|nullmono_font?|nullog_image_url?string|nullpowered_by_enabled?boolean|nullprimary_color?|nullsocial_linkedin?|nullsocial_twitter?|nullsocial_website?|nullsupport_email?|nullsurface_color?|nulltagline?|nulltext_color?|nullSuccessful Response
application/json- response
Full branding config returned to the frontend.
accent_color*Accent Colorbackground_color*Background Colorbody_font*Body Fontbusiness_name*Business Namecreated_at*Created AtFormat
date-timecustom_domain?string|nulldescription?string|nulldomain_verified*Domain Verifiededge_instance_id?|nullfavicon_url?string|nullheading_font*Heading Fontid*IdFormat
uuidlogo_url?string|nullmono_font*Mono Fontog_image_url?string|nullpowered_by_enabled*Powered By Enabledprimary_color*Primary Colorsocial_linkedin?string|nullsocial_twitter?string|nullsocial_website?string|nullssl_error?string|nullssl_status?Ssl StatusDefault
"none"support_email?string|nullsurface_color*Surface Colortagline?string|nulltenant_id*Tenant IdFormat
uuidtext_color*Text Colorupdated_at*Updated AtFormat
date-timecurl -X PUT 'https://example.com/v1/brand' \ -H 'Content-Type: application/json' \ -d '{}'Example Response
{ "accent_color": "string", "background_color": "string", "body_font": "string", "business_name": "string", "created_at": "2019-08-24T14:15:22Z", "custom_domain": "string", "description": "string", "domain_verified": true, "edge_instance_id": "6552900c-5e1f-46a9-8b32-a26e16ab8ecd", "favicon_url": "string", "heading_font": "string", "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "logo_url": "string", "mono_font": "string", "og_image_url": "string", "powered_by_enabled": true, "primary_color": "string", "social_linkedin": "string", "social_twitter": "string", "social_website": "string", "ssl_error": "string", "ssl_status": "none", "support_email": "string", "surface_color": "string", "tagline": "string", "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0", "text_color": "string", "updated_at": "2019-08-24T14:15:22Z"}POST
HTTPBearerheader
AuthorizationBearer <token>X-Api-Key?string|nullmultipart/form-data- body
file*FileFormat
binarySuccessful Response
application/json- response
Full branding config returned to the frontend.
accent_color*Accent Colorbackground_color*Background Colorbody_font*Body Fontbusiness_name*Business Namecreated_at*Created AtFormat
date-timecustom_domain?string|nulldescription?string|nulldomain_verified*Domain Verifiededge_instance_id?|nullfavicon_url?string|nullheading_font*Heading Fontid*IdFormat
uuidlogo_url?string|nullmono_font*Mono Fontog_image_url?string|nullpowered_by_enabled*Powered By Enabledprimary_color*Primary Colorsocial_linkedin?string|nullsocial_twitter?string|nullsocial_website?string|nullssl_error?string|nullssl_status?Ssl StatusDefault
"none"support_email?string|nullsurface_color*Surface Colortagline?string|nulltenant_id*Tenant IdFormat
uuidtext_color*Text Colorupdated_at*Updated AtFormat
date-timecurl -X POST 'https://example.com/v1/brand/logo' \ -F 'file=string'Example Response
{ "accent_color": "string", "background_color": "string", "body_font": "string", "business_name": "string", "created_at": "2019-08-24T14:15:22Z", "custom_domain": "string", "description": "string", "domain_verified": true, "edge_instance_id": "6552900c-5e1f-46a9-8b32-a26e16ab8ecd", "favicon_url": "string", "heading_font": "string", "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "logo_url": "string", "mono_font": "string", "og_image_url": "string", "powered_by_enabled": true, "primary_color": "string", "social_linkedin": "string", "social_twitter": "string", "social_website": "string", "ssl_error": "string", "ssl_status": "none", "support_email": "string", "surface_color": "string", "tagline": "string", "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0", "text_color": "string", "updated_at": "2019-08-24T14:15:22Z"}GET
filename*FilenameSuccessful Response
response?unknownapplication/jsoncurl -X GET 'https://example.com/v1/brand/logo/string'Example Response
null