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

Formatuuid

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

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

Formatdate-time

nda?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<>

Contacts to add

contacts_update?array<>

Contacts to update

contacts_remove?array<string>

Contact IDs to remove

Response Body

`application/json`

curl -X PATCH "https://example.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

How is this guide?

Authorization

Path Parameters

Request Body

Response Body

200application/json

400application/json

401

403

404

500

`application/json`

`application/json`