Create account
Create a new customer account with optional contacts and initial configuration.
AuthorizationBearer <token>
In: header
titlestring
Account/company name
Length
1 <= lengthdescription?string
Account description or notes
review_status?string
Initial review status
Default
"to_review"Value in
"to_review" | "in_progress" | "approved" | "cancelled"auto_approval?boolean
Whether to automatically approve access requests from this account's domain
Default
falsecontacts?array<object>
Initial contact persons to create
Response Body
const body = JSON.stringify({
"title": "Burger King"
})
fetch("https://app.orbiqhq.com/api/v1/accounts", {
body
}){
"success": true,
"data": {
"account": {
"id": "550e8400-e29b-41d4-a716-446655440000",
"title": "Burger King",
"description": "Fast-food chain EU division",
"review_status": "approved",
"sfdc_account_id": "string",
"domain": "burgerking.com",
"logo": "string",
"access_expiry_datetime": "2019-08-24T14:15:22Z",
"nda": false,
"type": "enterprise",
"internal_notes": "string",
"auto_approval": false,
"date_created": "2025-01-15T10:00:00Z",
"contacts": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"email": "user@example.com",
"first_name": "string",
"last_name": "string",
"title": "string"
}
]
}
}
}{
"error": "Invalid input: title: String must contain at least 1 character(s)"
}Empty
Empty
Empty
How is this guide?