Accounts
Create Accounts From an Organization ID
Create one account per organization ID and add its contacts as members
POST
Create Accounts From an Organization ID
Starts a background job that creates one account per distinct value of
propertyKey and adds each contact seen with that value as a member. Preview the result first, then check progress with Get Organization ID Job.
- Accounts are named from
nameKeywhen you pass one, otherwise after the work email domain most of their contacts share. That domain is also saved on the account. - Existing accounts keep their names, domains and member roles.
- No emails are sent, no sync rules run and segment-entered sequences are not triggered.
- For
event, events from the last 180 days are used.
409 rule as creating an account. Only one run per key runs at a time. While one is queued or running, this returns it with alreadyRunning: true instead of starting another. That run keeps its own settings, shown in job.settings; start again after it finishes to use a different source or nameKey. Accounts stays on even if the job later fails. Running it again later is safe: it updates the same accounts and memberships.
Requires the subscribers:write scope.
Request
string
required
Event property or contact attribute holding your organization ID. Trimmed.
string
default:"event"
event for an event property, attribute for a contact attribute.string | null
Property or attribute holding the organization name.
Response
Returns202 Accepted.
string
Pass to Get Organization ID
Job.
boolean
true when a run for this key was already queued or running, so no new run
started.object
The job’s current status, as returned by Get Organization ID
Job.