API ReferencePartner
Update a company (name, reference, plan)
PATCH /rest/v1/accounts/{id}
A plan change is billed prorated from today; the company gets the new plan's limits at once.
Required scope: accounts:manage.
Authorization
apiKey AuthorizationBearer <token>
Authorization: Bearer nbl_live_... (or nbl_test_... for test mode). Test-mode writes are validated and simulated but never persisted and never touch channels; simulated results are marked simulated.
In: header
Path Parameters
id*string
Header Parameters
Idempotency-Key?string
Unique client-generated key (max 255 chars), stored 24h.
Length
length <= 255Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
curl -X PATCH "https://example.com/accounts/string" \ -H "Content-Type: application/json" \ -d '{}'{ "id": "acct_66f0a1", "object": "account", "name": "string", "reference": "string", "plan": "basic", "country": "string", "currency": "string", "status": "active", "product_limit": 0, "channel_accounts": 0, "products": 0, "created_at": "2019-08-24T14:15:22Z", "closed_at": "2019-08-24T14:15:22Z"}Last updated on October 18, 2026
Need help?
Email us and a human replies, usually within one business day.