POST

api

account-suggestions

organization-ids

Create Accounts From an Organization ID

curl --request POST \
  --url https://api.sequenzy.com/api/v1/account-suggestions/organization-ids \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "propertyKey": "<string>",
  "source": "<string>",
  "nameKey": {}
}
'

import requests

url = "https://api.sequenzy.com/api/v1/account-suggestions/organization-ids"

payload = {
    "propertyKey": "<string>",
    "source": "<string>",
    "nameKey": {}
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({propertyKey: '<string>', source: '<string>', nameKey: {}})
};

fetch('https://api.sequenzy.com/api/v1/account-suggestions/organization-ids', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.sequenzy.com/api/v1/account-suggestions/organization-ids",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'propertyKey' => '<string>',
    'source' => '<string>',
    'nameKey' => [
        
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.sequenzy.com/api/v1/account-suggestions/organization-ids"

	payload := strings.NewReader("{\n  \"propertyKey\": \"<string>\",\n  \"source\": \"<string>\",\n  \"nameKey\": {}\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.sequenzy.com/api/v1/account-suggestions/organization-ids")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"propertyKey\": \"<string>\",\n  \"source\": \"<string>\",\n  \"nameKey\": {}\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.sequenzy.com/api/v1/account-suggestions/organization-ids")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"propertyKey\": \"<string>\",\n  \"source\": \"<string>\",\n  \"nameKey\": {}\n}"

response = http.request(request)
puts response.read_body

{
  "success": true,
  "jobId": "backfill-accounts:comp_123:organization_id",
  "alreadyRunning": false,
  "job": {
    "jobId": "backfill-accounts:comp_123:organization_id",
    "state": "queued",
    "settings": {
      "source": "event",
      "propertyKey": "organization_id",
      "nameKey": null
    },
    "result": null,
    "error": null
  }
}

{ "success": false, "error": "`propertyKey` cannot be blank." }

{ "success": false, "error": "Unauthorized" }

{ "success": false, "error": "No company selected" }

{
  "success": false,
  "error": "Contacts in this workspace already use the custom attribute `account.plan`. Accounts reserve the `account` attribute name for organization data, so turning Accounts on would stop those contact attributes from updating in segments. Rename them (for example to `company.plan`), then try again."
}

{ "success": false, "error": "Expected property 'propertyKey' to be string" }

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 nameKey when 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.

The first run turns Accounts on for the workspace, with the same 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.

curl -X POST "https://api.sequenzy.com/api/v1/account-suggestions/organization-ids" \
  -H "Authorization: Bearer API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"propertyKey": "organization_id"}'

Response

Returns 202 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.

{
  "success": true,
  "jobId": "backfill-accounts:comp_123:organization_id",
  "alreadyRunning": false,
  "job": {
    "jobId": "backfill-accounts:comp_123:organization_id",
    "state": "queued",
    "settings": {
      "source": "event",
      "propertyKey": "organization_id",
      "nameKey": null
    },
    "result": null,
    "error": null
  }
}

{ "success": false, "error": "`propertyKey` cannot be blank." }

{ "success": false, "error": "Unauthorized" }

{ "success": false, "error": "No company selected" }

{
  "success": false,
  "error": "Contacts in this workspace already use the custom attribute `account.plan`. Accounts reserve the `account` attribute name for organization data, so turning Accounts on would stop those contact attributes from updating in segments. Rename them (for example to `company.plan`), then try again."
}

{ "success": false, "error": "Expected property 'propertyKey' to be string" }

Create Accounts From an Organization ID

curl --request POST \
  --url https://api.sequenzy.com/api/v1/account-suggestions/organization-ids \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "propertyKey": "<string>",
  "source": "<string>",
  "nameKey": {}
}
'

import requests

url = "https://api.sequenzy.com/api/v1/account-suggestions/organization-ids"

payload = {
    "propertyKey": "<string>",
    "source": "<string>",
    "nameKey": {}
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({propertyKey: '<string>', source: '<string>', nameKey: {}})
};

fetch('https://api.sequenzy.com/api/v1/account-suggestions/organization-ids', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.sequenzy.com/api/v1/account-suggestions/organization-ids",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'propertyKey' => '<string>',
    'source' => '<string>',
    'nameKey' => [
        
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.sequenzy.com/api/v1/account-suggestions/organization-ids"

	payload := strings.NewReader("{\n  \"propertyKey\": \"<string>\",\n  \"source\": \"<string>\",\n  \"nameKey\": {}\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.sequenzy.com/api/v1/account-suggestions/organization-ids")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"propertyKey\": \"<string>\",\n  \"source\": \"<string>\",\n  \"nameKey\": {}\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.sequenzy.com/api/v1/account-suggestions/organization-ids")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"propertyKey\": \"<string>\",\n  \"source\": \"<string>\",\n  \"nameKey\": {}\n}"

response = http.request(request)
puts response.read_body

{
  "success": true,
  "jobId": "backfill-accounts:comp_123:organization_id",
  "alreadyRunning": false,
  "job": {
    "jobId": "backfill-accounts:comp_123:organization_id",
    "state": "queued",
    "settings": {
      "source": "event",
      "propertyKey": "organization_id",
      "nameKey": null
    },
    "result": null,
    "error": null
  }
}

{ "success": false, "error": "`propertyKey` cannot be blank." }

{ "success": false, "error": "Unauthorized" }

{ "success": false, "error": "No company selected" }

{
  "success": false,
  "error": "Contacts in this workspace already use the custom attribute `account.plan`. Accounts reserve the `account` attribute name for organization data, so turning Accounts on would stop those contact attributes from updating in segments. Rename them (for example to `company.plan`), then try again."
}

{ "success": false, "error": "Expected property 'propertyKey' to be string" }

​Create Accounts From an Organization ID

​Request

​Response

Create Accounts From an Organization ID

Request

Response