Create Company - Sequenzy

POST

api

companies

Create Company

curl --request POST \
  --url https://api.sequenzy.com/api/v1/companies \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "domain": "<string>",
  "name": "<string>",
  "noWebsite": true,
  "description": "<string>",
  "withWelcomeSequence": true
}
'

import requests

url = "https://api.sequenzy.com/api/v1/companies"

payload = {
    "domain": "<string>",
    "name": "<string>",
    "noWebsite": True,
    "description": "<string>",
    "withWelcomeSequence": True
}
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({
    domain: '<string>',
    name: '<string>',
    noWebsite: true,
    description: '<string>',
    withWelcomeSequence: true
  })
};

fetch('https://api.sequenzy.com/api/v1/companies', 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/companies",
  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([
    'domain' => '<string>',
    'name' => '<string>',
    'noWebsite' => true,
    'description' => '<string>',
    'withWelcomeSequence' => true
  ]),
  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/companies"

	payload := strings.NewReader("{\n  \"domain\": \"<string>\",\n  \"name\": \"<string>\",\n  \"noWebsite\": true,\n  \"description\": \"<string>\",\n  \"withWelcomeSequence\": true\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/companies")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"domain\": \"<string>\",\n  \"name\": \"<string>\",\n  \"noWebsite\": true,\n  \"description\": \"<string>\",\n  \"withWelcomeSequence\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.sequenzy.com/api/v1/companies")

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  \"domain\": \"<string>\",\n  \"name\": \"<string>\",\n  \"noWebsite\": true,\n  \"description\": \"<string>\",\n  \"withWelcomeSequence\": true\n}"

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

{
  "success": true,
  "company": {
    "id": "company_abc123",
    "name": "Acme",
    "status": "processing",
    "websiteUrl": "https://acme.com"
  },
  "welcomeAutomationId": "automation_abc123",
  "welcomeEnrichmentJobId": "job_abc123",
  "message": "Company created. Processing your website to extract brand information. This typically takes 30-60 seconds."
}

{
  "error": "Unauthorized"
}

{
  "error": "Name is required when starting without a website."
}

{
  "type": "validation",
  "on": "body",
  "property": "/name",
  "message": "Expected string",
  "summary": "Expected property 'name' to be string but found: 42"
}

{
  "error": "This API key is scoped to a single company, so it cannot create another one. The new company would be created under the key owner's account, but this key could never list, select, or use it. Retry with a personal account key (seq_user_...) from Account -> API Keys, or create the company in the dashboard.",
  "code": "COMPANY_CREATE_REQUIRES_PERSONAL_KEY"
}

{
  "error": "Failed to create company"
}

Create a company workspace. Provide a website domain to queue brand processing, or set noWebsite and provide a name to start without one. Set withWelcomeSequence to create and generate the four-email welcome sequence; the optional description grounds that sequence when no website is available.

This endpoint requires a personal account key (seq_user_...). A company-scoped key (seq_live_... or a legacy ek_... key) is bound to the single company it was created for, so it is rejected with 403 - it could never access the workspace it created.

Creating another company does not create another core email subscription. Companies owned by the same account share its plan and monthly email usage. See Workspaces, Billing, and Shared Limits.

Request

string

Company website domain or URL. Required unless noWebsite is true. When you send both, Sequenzy uses the domain.

string

Company display name. If omitted, Sequenzy derives it from the domain. Website processing may later replace it with the name found on your site. Required when noWebsite is true and you send no domain.

boolean

Set to true (any other value is ignored) to create without a website. The workspace is ready at once (status: "processed") and no website processing is queued. name is required when you send no domain.

string

Optional business description, up to 500 characters, stored trimmed as product context for the welcome-sequence generator. Without a website, a non-null value that is not a string or is longer than 500 characters returns 400. With a domain, such a value is ignored, and website processing may later replace the description with the one found on your site.

boolean

Set to true to create a draft four-email welcome sequence and queue its generation. Defaults to false; any other value is treated as false. The sequence stays a draft until you turn it on. If the sequence cannot be created, the company is still created and both welcome fields are null. If only queueing fails, welcomeAutomationId is set and welcomeEnrichmentJobId is null; open the sequence in the editor to retry generation.

With a website

curl -X POST "https://api.sequenzy.com/api/v1/companies" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"domain": "acme.com", "name": "Acme", "withWelcomeSequence": true}'

Without a website

curl -X POST "https://api.sequenzy.com/api/v1/companies" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"noWebsite": true, "name": "Night Shift Meals", "description": "Weekly meal plans for night-shift nurses", "withWelcomeSequence": true}'

Responses

{
  "success": true,
  "company": {
    "id": "company_abc123",
    "name": "Acme",
    "status": "processing",
    "websiteUrl": "https://acme.com"
  },
  "welcomeAutomationId": "automation_abc123",
  "welcomeEnrichmentJobId": "job_abc123",
  "message": "Company created. Processing your website to extract brand information. This typically takes 30-60 seconds."
}

{
  "error": "Unauthorized"
}

{
  "error": "Name is required when starting without a website."
}

{
  "type": "validation",
  "on": "body",
  "property": "/name",
  "message": "Expected string",
  "summary": "Expected property 'name' to be string but found: 42"
}

{
  "error": "This API key is scoped to a single company, so it cannot create another one. The new company would be created under the key owner's account, but this key could never list, select, or use it. Retry with a personal account key (seq_user_...) from Account -> API Keys, or create the company in the dashboard.",
  "code": "COMPANY_CREATE_REQUIRES_PERSONAL_KEY"
}

{
  "error": "Failed to create company"
}

Create Company

curl --request POST \
  --url https://api.sequenzy.com/api/v1/companies \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "domain": "<string>",
  "name": "<string>",
  "noWebsite": true,
  "description": "<string>",
  "withWelcomeSequence": true
}
'

import requests

url = "https://api.sequenzy.com/api/v1/companies"

payload = {
    "domain": "<string>",
    "name": "<string>",
    "noWebsite": True,
    "description": "<string>",
    "withWelcomeSequence": True
}
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({
    domain: '<string>',
    name: '<string>',
    noWebsite: true,
    description: '<string>',
    withWelcomeSequence: true
  })
};

fetch('https://api.sequenzy.com/api/v1/companies', 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/companies",
  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([
    'domain' => '<string>',
    'name' => '<string>',
    'noWebsite' => true,
    'description' => '<string>',
    'withWelcomeSequence' => true
  ]),
  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/companies"

	payload := strings.NewReader("{\n  \"domain\": \"<string>\",\n  \"name\": \"<string>\",\n  \"noWebsite\": true,\n  \"description\": \"<string>\",\n  \"withWelcomeSequence\": true\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/companies")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"domain\": \"<string>\",\n  \"name\": \"<string>\",\n  \"noWebsite\": true,\n  \"description\": \"<string>\",\n  \"withWelcomeSequence\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.sequenzy.com/api/v1/companies")

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  \"domain\": \"<string>\",\n  \"name\": \"<string>\",\n  \"noWebsite\": true,\n  \"description\": \"<string>\",\n  \"withWelcomeSequence\": true\n}"

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

{
  "success": true,
  "company": {
    "id": "company_abc123",
    "name": "Acme",
    "status": "processing",
    "websiteUrl": "https://acme.com"
  },
  "welcomeAutomationId": "automation_abc123",
  "welcomeEnrichmentJobId": "job_abc123",
  "message": "Company created. Processing your website to extract brand information. This typically takes 30-60 seconds."
}

{
  "error": "Unauthorized"
}

{
  "error": "Name is required when starting without a website."
}

{
  "type": "validation",
  "on": "body",
  "property": "/name",
  "message": "Expected string",
  "summary": "Expected property 'name' to be string but found: 42"
}

{
  "error": "This API key is scoped to a single company, so it cannot create another one. The new company would be created under the key owner's account, but this key could never list, select, or use it. Retry with a personal account key (seq_user_...) from Account -> API Keys, or create the company in the dashboard.",
  "code": "COMPANY_CREATE_REQUIRES_PERSONAL_KEY"
}

{
  "error": "Failed to create company"
}

​Request

​Responses

Request

Responses