Update account
Update account information, contacts, and associated documents. Supports adding, updating, and removing contacts.
AuthorizationBearer <token>
In: header
Path Parameters
idstring
Account ID
Format
uuidtitle?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<string>
Document IDs to associate
contacts_add?array<object>
Contacts to add
contacts_update?array<object>
Contacts to update
contacts_remove?array<string>
Contact IDs to remove
Response Body
const body = JSON.stringify({})fetch("https://app.orbiqhq.com/api/v1/accounts/497f6eca-6276-4993-bfeb-53cbbbba6f08", { method: "PATCH", headers: { "Content-Type": "application/json" }, body}){
"success": true,
"data": {
"ok": true
}
}{
"error": "string"
}Empty
Empty
Empty
Empty
How is this guide?