Sign in

v1

latestOpenAPI 3.1.02026-07-131315.4 KB
Brands

Create a brand

Creates a BoldSign brand profile that can be used to customize signing pages, email notifications, and document signing workflows.

post/v1/brand/create

Request body

brandNamestring required

Display name of the brand that appears in BoldSign signing workflows.

brandColorstring

Primary brand color in hexadecimal format.

logoUrlstring uri

Public HTTPS URL of the brand logo.

emailDisplayNamestring

Display name used in branded email notifications.

emailReplyTostring email

Reply-to email address used for branded signing emails.

Example request

{
  "brandName": "Acme Corp",
  "brandColor": "#2563EB",
  "logoUrl": "https://example.com/logo.png",
  "emailDisplayName": "Acme Signing Team",
  "emailReplyTo": "signing@example.com"
}

Response

Brand created successfully.

brandIdstring required

Unique identifier of the created BoldSign brand.

brandNamestring required

Display name of the created brand.

status'created' required

Creation status of the brand.

Example response

{
  "brandId": "brand_123456",
  "brandName": "Acme Corp",
  "status": "created"
}
All 1 operations