Update a Dock
Updates one or more fields on an existing dock. Only include the fields you want to change.
Path Parameters
| Parameter | Type | Description |
|---|
id | string | The dock ID |
Request Body
All fields are optional. Only provided fields are updated.
| Parameter | Type | Description |
|---|
name | string | Display name |
domain | string | Primary domain |
customDomain | string | Custom domain for branded portal |
legalName | string | Legal business name |
businessType | string | Business entity type |
taxId | string | Tax identification number |
registrationNumber | string | Business registration number |
businessAddress | object | Company address |
businessPhone | string | Business phone |
businessEmail | string | Business email |
primaryColor | string | Hex color for branding |
secondaryColor | string | Hex color for secondary branding |
customCss | string | Custom CSS for recipient portal |
Example Request
curl -X PATCH https://api.docyard.io/v1/docks/dock_01HQ3K... \
-H "Authorization: Bearer dk_live_a1b2c3d4..." \
-H "Content-Type: application/json" \
-d '{
"name": "Acme Insurance Group",
"primaryColor": "#004488"
}'
Response
Returns the full updated dock object.
{
"id": "dock_01HQ3K...",
"name": "Acme Insurance Group",
"primaryColor": "#004488",
"updatedAt": "2025-01-21T08:00:00.000Z"
}
Error Handling
| Status | Condition |
|---|
400 | domain or customDomain already claimed by another dock |
401 | Missing or invalid API key |
404 | Dock not found |
Changing the domain field resets domainVerificationStatus to UNVERIFIED. You must re-verify the new domain.
