Accounts

Create accounts from an organization ID

Changed on

Starts a background job that creates one account per distinct value of propertyKey and adds each contact seen with that value as a member. Accounts are named from nameKey when set, otherwise after the work email domain most of their contacts share; existing names, domains and roles are kept. No emails are sent, no sync rules run and segment-entered sequences are not triggered. A run already queued or running for the same key is returned with alreadyRunning set instead of starting another; its job.settings show the source and name key it uses. Reruns are safe. Accounts is turned on before the job is queued and stays on even if the job fails.

post/account-suggestions/organization-ids

Request

  • Base URL
    https://api.sequenzy.com/api/v1
  • URL
    https://api.sequenzy.com/api/v1/account-suggestions/organization-ids
  • Auth
    HTTP bearer

Request body

propertyKeystring required

Event property or contact attribute holding your organization ID, such as workspaceId. Trimmed.

source'event' | 'attribute'

Where the ID lives.

nameKeystring nullable

Property or attribute holding the organization name. Without it, accounts are named after the work email domain their contacts share.

Response

Job queued, or the run already in progress for this key

successboolean
jobIdstring

Pass to GET /account-suggestions/organization-ids/jobs/{jobId}.

alreadyRunningboolean

True when a run for this key was already queued or running, so none was started.

Changes