Recomly APIEndpointsAccount
Update account
Update the organization's business name or accept the Terms of Service.
PATCH /api/app/account
Updates the organization's business name. During the initial onboarding flow, providing tosAccepted: true alongside a businessName activates the account and triggers a one-time welcome email.
Requires the admin role.
Request
See API Basics for required headers.
Request body
| Field | Type | Required | Description |
|---|---|---|---|
businessName | string | No | Display name for the organization. Max 150 characters. |
tosAccepted | boolean | No | Set true to accept the Terms of Service. Required during initial onboarding when status is pending_onboarding. |
Sample request
curl -X PATCH https://api.recomly.com/api/app/account \
-H "Authorization: Bearer rk_live_abc123:def456" \
-H "Content-Type: application/json" \
-d '{"businessName": "Acme Plumbing Co."}'Sample response
Status: 200 OK
{
"org": {
"orgId": "a1b2c3d4-0000-4000-8000-e5f6a7b8c9d0",
"name": "Acme Plumbing Co.",
"status": "active",
"tier": "pro",
"createdAt": "2026-01-15T09:00:00.000Z",
"tosAcceptedAt": "2026-01-16T10:30:00.000Z",
"tosVersion": "2026-01-01"
}
}tosAcceptedAt and tosVersion are omitted when the ToS has not been accepted.
Error responses
See API Basics for standard status codes and error response format.
| Status | Meaning |
|---|---|
400 | Validation failure — e.g. businessName is required when completing onboarding. |
403 | Caller does not have the admin role. |
404 | Organization not found. |