Skip to main content
POST
Create or Update Account

Create or Update Account

Creates the account when externalId is new, otherwise updates it. Attributes merge into the stored attributes: send null to delete a key, or replaceAttributes: true to replace them all. Attribute changes fan out to every member for segments and {{account.*}} merge tags. Your first account turns Accounts on for the workspace. If your contacts already carry a custom attribute named account or account.<name>, this returns 409 until you rename it, because account data takes over the account.* names in segments.

Request

string
required
Your organization ID. Case-sensitive, unique per workspace, up to 255 characters.
string
Display name. null clears it.
string
Primary domain, normalized to a hostname (https://www.acme.com/ becomes acme.com). null clears it.
object
Up to 100 attributes such as plan, seats, mrr, trialEndsAt. Values may be strings, numbers, booleans, arrays of those, or nested objects (flattened to dotted names). Keys starting with internal__ are reserved.
boolean
default:"false"
Replace all stored attributes instead of merging.
array
Up to 100 contacts to add in the same call. Each item takes email or externalId, an optional role (owner, admin, member), firstName and lastName. New emails create the contact; external-ID-only members must already exist. Member roles and identities are checked before changing the account or adding contacts.

Responses