Update account
Update account information, contacts, and associated documents. Supports adding, updating, and removing contacts.
Authorization
bearerAuth AuthorizationBearer <token>
In: header
Path Parameters
id*string
Account ID
Format
uuidRequest Body
application/json
title?string
Account name
description?string
Account description
review_status?string
Review status
Value in
"to_review" | "in_review" | "approved" | "cancelled"sfdc_account_id?string
Salesforce ID
domain?string
Primary domain
logo?string
Logo ID
access_expiry_datetime?string
Access expiry
Format
date-timenda?boolean
NDA requirement
type?string
Account type
Value in
"standard" | "enterprise"internal_notes?string
Internal notes
auto_approval?boolean
Whether to automatically approve access requests from this account's domain
documents?array<>
Document IDs to associate
contacts_add?array<>
Contacts to add
contacts_update?array<>
Contacts to update
contacts_remove?array<>
Contact IDs to remove
Response Body
application/json
application/json
curl -X PATCH "https://app.orbiqhq.com/api/v1/accounts/550e8400-e29b-41d4-a716-446655440000" \ -H "Content-Type: application/json" \ -d '{ "title": "Updated Company Name", "description": "Updated description", "review_status": "approved" }'{
"success": true,
"data": {
"ok": true
}
}{
"error": "string"
}Empty
Empty
Empty
Empty
How is this guide?