PATCH Accounts
Use this endpoint to update existing accounts such as customers, vendors, and carriers.
User level: Advanced
Endpoint
PATCH /v1/{scopeId}/accounts/{id}| Property | Value |
|---|---|
| Method | PATCH |
| Scope ID | Branch UUID |
| Authentication | Authorization: Bearer <access_token> |
| Required scope | routix:accounts:write |
| Content-Type | application/json |
| Request body | JSON object |
Update rules
- The API validates server-side whether the record belongs to the allowed organization and branch.
- Only explicitly allowed fields can be updated.
- Unknown or disallowed fields return
400 invalid_update.
Allowed update fields
| Field |
|---|
company_name |
email |
phone |
account_type |
status |
website |
industry |
lead_source |
visit_address_street |
visit_address_number |
visit_address_addition |
visit_address_zipcode |
visit_address_city |
shipping_address_street |
shipping_address_number |
shipping_address_addition |
shipping_address_zipcode |
shipping_address_city |
billing_address_street |
billing_address_number |
billing_address_addition |
billing_address_zipcode |
billing_address_city |
invoice_email |
vat_number |
chamber_of_commerce_number |
iban |
bic |
payment_terms |
credit_limit |
comment |
registration_date |
Example request
curl -X PATCH "https://api.routix.com/v1/550e8400-e29b-41d4-a716-446655440000/accounts/550e8400-e29b-41d4-a716-446655440000" \
-H "Authorization: Bearer eyJhbGciOiJIUzI1NiIs..." \
-H "Content-Type: application/json" \
-d '{
"status": "active",
"company_name": "Acme Transport B.V."
}'Example response
{
"data": {
"id": "550e8400-e29b-41d4-a716-446655440000",
"company_name": "Acme Transport B.V.",
"email": "[email protected]",
"phone": "+31 20 123 4567",
"account_type": "customer",
"status": "active"
},
"version": "v1"
}Error responses
{
"error": "invalid_update",
"error_description": "One or more fields are not allowed for updates on accounts"
}Possible error codes
400 invalid_request400 invalid_update401 unauthorized401 invalid_token403 invalid_token_type403 insufficient_scope404 not_found405 method_not_allowed
Related pages
- Accounts GET
- API calls & examples
- Setup guide
Last updated on
