curl --request POST \
--url https://app.chainpatrol.io/api/v2/staff/organization/create \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: <api-key>' \
--data '
{
"organization": {
"name": "<string>",
"slug": "<string>",
"accountExecName": "<string>",
"accountExecEmail": "jsmith@example.com",
"description": "<string>",
"websiteUrl": "<string>",
"twitterHandle": "<string>",
"avatarUrl": "<string>",
"subscriptionStatus": "PROSPECT",
"isReportingActive": true,
"isAutomatedReportingActive": true,
"isReviewingActive": true,
"isAutomatedReviewingActive": true,
"isProtectionActive": true,
"isAutomatedProtectionActive": true,
"isTakedownsActive": true,
"isDetectionActive": true,
"requiresCustomerReview": true
},
"owner": {
"fullName": "<string>",
"email": "jsmith@example.com",
"avatarUrl": "<string>"
},
"officialAssets": [
{
"content": "<string>",
"name": "<string>"
}
],
"brands": [
{
"name": "<string>",
"slug": "<string>",
"websiteUrl": "<string>",
"twitterHandle": "<string>",
"includedTerms": "<string>",
"excludedTerms": "<string>",
"noOfficialAssets": [],
"officialAssets": [
"<string>"
]
}
]
}
'import requests
url = "https://app.chainpatrol.io/api/v2/staff/organization/create"
payload = {
"organization": {
"name": "<string>",
"slug": "<string>",
"accountExecName": "<string>",
"accountExecEmail": "jsmith@example.com",
"description": "<string>",
"websiteUrl": "<string>",
"twitterHandle": "<string>",
"avatarUrl": "<string>",
"subscriptionStatus": "PROSPECT",
"isReportingActive": True,
"isAutomatedReportingActive": True,
"isReviewingActive": True,
"isAutomatedReviewingActive": True,
"isProtectionActive": True,
"isAutomatedProtectionActive": True,
"isTakedownsActive": True,
"isDetectionActive": True,
"requiresCustomerReview": True
},
"owner": {
"fullName": "<string>",
"email": "jsmith@example.com",
"avatarUrl": "<string>"
},
"officialAssets": [
{
"content": "<string>",
"name": "<string>"
}
],
"brands": [
{
"name": "<string>",
"slug": "<string>",
"websiteUrl": "<string>",
"twitterHandle": "<string>",
"includedTerms": "<string>",
"excludedTerms": "<string>",
"noOfficialAssets": [],
"officialAssets": ["<string>"]
}
]
}
headers = {
"X-API-KEY": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
organization: {
name: '<string>',
slug: '<string>',
accountExecName: '<string>',
accountExecEmail: 'jsmith@example.com',
description: '<string>',
websiteUrl: '<string>',
twitterHandle: '<string>',
avatarUrl: '<string>',
subscriptionStatus: 'PROSPECT',
isReportingActive: true,
isAutomatedReportingActive: true,
isReviewingActive: true,
isAutomatedReviewingActive: true,
isProtectionActive: true,
isAutomatedProtectionActive: true,
isTakedownsActive: true,
isDetectionActive: true,
requiresCustomerReview: true
},
owner: {fullName: '<string>', email: 'jsmith@example.com', avatarUrl: '<string>'},
officialAssets: [{content: '<string>', name: '<string>'}],
brands: [
{
name: '<string>',
slug: '<string>',
websiteUrl: '<string>',
twitterHandle: '<string>',
includedTerms: '<string>',
excludedTerms: '<string>',
noOfficialAssets: [],
officialAssets: ['<string>']
}
]
})
};
fetch('https://app.chainpatrol.io/api/v2/staff/organization/create', 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://app.chainpatrol.io/api/v2/staff/organization/create",
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([
'organization' => [
'name' => '<string>',
'slug' => '<string>',
'accountExecName' => '<string>',
'accountExecEmail' => 'jsmith@example.com',
'description' => '<string>',
'websiteUrl' => '<string>',
'twitterHandle' => '<string>',
'avatarUrl' => '<string>',
'subscriptionStatus' => 'PROSPECT',
'isReportingActive' => true,
'isAutomatedReportingActive' => true,
'isReviewingActive' => true,
'isAutomatedReviewingActive' => true,
'isProtectionActive' => true,
'isAutomatedProtectionActive' => true,
'isTakedownsActive' => true,
'isDetectionActive' => true,
'requiresCustomerReview' => true
],
'owner' => [
'fullName' => '<string>',
'email' => 'jsmith@example.com',
'avatarUrl' => '<string>'
],
'officialAssets' => [
[
'content' => '<string>',
'name' => '<string>'
]
],
'brands' => [
[
'name' => '<string>',
'slug' => '<string>',
'websiteUrl' => '<string>',
'twitterHandle' => '<string>',
'includedTerms' => '<string>',
'excludedTerms' => '<string>',
'noOfficialAssets' => [
],
'officialAssets' => [
'<string>'
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-KEY: <api-key>"
],
]);
$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://app.chainpatrol.io/api/v2/staff/organization/create"
payload := strings.NewReader("{\n \"organization\": {\n \"name\": \"<string>\",\n \"slug\": \"<string>\",\n \"accountExecName\": \"<string>\",\n \"accountExecEmail\": \"jsmith@example.com\",\n \"description\": \"<string>\",\n \"websiteUrl\": \"<string>\",\n \"twitterHandle\": \"<string>\",\n \"avatarUrl\": \"<string>\",\n \"subscriptionStatus\": \"PROSPECT\",\n \"isReportingActive\": true,\n \"isAutomatedReportingActive\": true,\n \"isReviewingActive\": true,\n \"isAutomatedReviewingActive\": true,\n \"isProtectionActive\": true,\n \"isAutomatedProtectionActive\": true,\n \"isTakedownsActive\": true,\n \"isDetectionActive\": true,\n \"requiresCustomerReview\": true\n },\n \"owner\": {\n \"fullName\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"avatarUrl\": \"<string>\"\n },\n \"officialAssets\": [\n {\n \"content\": \"<string>\",\n \"name\": \"<string>\"\n }\n ],\n \"brands\": [\n {\n \"name\": \"<string>\",\n \"slug\": \"<string>\",\n \"websiteUrl\": \"<string>\",\n \"twitterHandle\": \"<string>\",\n \"includedTerms\": \"<string>\",\n \"excludedTerms\": \"<string>\",\n \"noOfficialAssets\": [],\n \"officialAssets\": [\n \"<string>\"\n ]\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-KEY", "<api-key>")
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://app.chainpatrol.io/api/v2/staff/organization/create")
.header("X-API-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"organization\": {\n \"name\": \"<string>\",\n \"slug\": \"<string>\",\n \"accountExecName\": \"<string>\",\n \"accountExecEmail\": \"jsmith@example.com\",\n \"description\": \"<string>\",\n \"websiteUrl\": \"<string>\",\n \"twitterHandle\": \"<string>\",\n \"avatarUrl\": \"<string>\",\n \"subscriptionStatus\": \"PROSPECT\",\n \"isReportingActive\": true,\n \"isAutomatedReportingActive\": true,\n \"isReviewingActive\": true,\n \"isAutomatedReviewingActive\": true,\n \"isProtectionActive\": true,\n \"isAutomatedProtectionActive\": true,\n \"isTakedownsActive\": true,\n \"isDetectionActive\": true,\n \"requiresCustomerReview\": true\n },\n \"owner\": {\n \"fullName\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"avatarUrl\": \"<string>\"\n },\n \"officialAssets\": [\n {\n \"content\": \"<string>\",\n \"name\": \"<string>\"\n }\n ],\n \"brands\": [\n {\n \"name\": \"<string>\",\n \"slug\": \"<string>\",\n \"websiteUrl\": \"<string>\",\n \"twitterHandle\": \"<string>\",\n \"includedTerms\": \"<string>\",\n \"excludedTerms\": \"<string>\",\n \"noOfficialAssets\": [],\n \"officialAssets\": [\n \"<string>\"\n ]\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.chainpatrol.io/api/v2/staff/organization/create")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"organization\": {\n \"name\": \"<string>\",\n \"slug\": \"<string>\",\n \"accountExecName\": \"<string>\",\n \"accountExecEmail\": \"jsmith@example.com\",\n \"description\": \"<string>\",\n \"websiteUrl\": \"<string>\",\n \"twitterHandle\": \"<string>\",\n \"avatarUrl\": \"<string>\",\n \"subscriptionStatus\": \"PROSPECT\",\n \"isReportingActive\": true,\n \"isAutomatedReportingActive\": true,\n \"isReviewingActive\": true,\n \"isAutomatedReviewingActive\": true,\n \"isProtectionActive\": true,\n \"isAutomatedProtectionActive\": true,\n \"isTakedownsActive\": true,\n \"isDetectionActive\": true,\n \"requiresCustomerReview\": true\n },\n \"owner\": {\n \"fullName\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"avatarUrl\": \"<string>\"\n },\n \"officialAssets\": [\n {\n \"content\": \"<string>\",\n \"name\": \"<string>\"\n }\n ],\n \"brands\": [\n {\n \"name\": \"<string>\",\n \"slug\": \"<string>\",\n \"websiteUrl\": \"<string>\",\n \"twitterHandle\": \"<string>\",\n \"includedTerms\": \"<string>\",\n \"excludedTerms\": \"<string>\",\n \"noOfficialAssets\": [],\n \"officialAssets\": [\n \"<string>\"\n ]\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"organization": {
"id": 123,
"name": "<string>",
"slug": "<string>",
"description": "<string>",
"websiteUrl": "<string>",
"subscriptionStatus": "POC",
"createdAt": "<string>"
},
"owner": {
"id": 123,
"email": "<string>",
"fullName": "<string>"
},
"brands": [
{
"id": 123,
"name": "<string>"
}
],
"brandAssetErrors": [
{
"brandName": "<string>",
"message": "<string>"
}
],
"skippedAssets": [
{
"content": "<string>",
"brandName": "<string>",
"reason": "<string>"
}
],
"dashboardUrl": "<string>"
}{
"code": "BAD_REQUEST",
"message": "Invalid input data",
"issues": []
}{
"code": "UNAUTHORIZED",
"message": "Authorization not provided",
"issues": []
}{
"code": "FORBIDDEN",
"message": "Insufficient access",
"issues": []
}{
"code": "INTERNAL_SERVER_ERROR",
"message": "Internal server error",
"issues": []
}Create Organization (Staff)
Create an organization exactly as ChainPatrol staff do from the app: the owner and the calling staff user are added as members, default asset groups and any initial brands are created, and the website and official assets are allowlisted. Only ChainPatrol staff can call this endpoint, with a staff session or a staff user API key; organization API keys and customer accounts receive 403. The website and official assets are allowlisted automatically, except any that are currently BLOCKED: those are skipped and listed in skippedAssets.
curl --request POST \
--url https://app.chainpatrol.io/api/v2/staff/organization/create \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: <api-key>' \
--data '
{
"organization": {
"name": "<string>",
"slug": "<string>",
"accountExecName": "<string>",
"accountExecEmail": "jsmith@example.com",
"description": "<string>",
"websiteUrl": "<string>",
"twitterHandle": "<string>",
"avatarUrl": "<string>",
"subscriptionStatus": "PROSPECT",
"isReportingActive": true,
"isAutomatedReportingActive": true,
"isReviewingActive": true,
"isAutomatedReviewingActive": true,
"isProtectionActive": true,
"isAutomatedProtectionActive": true,
"isTakedownsActive": true,
"isDetectionActive": true,
"requiresCustomerReview": true
},
"owner": {
"fullName": "<string>",
"email": "jsmith@example.com",
"avatarUrl": "<string>"
},
"officialAssets": [
{
"content": "<string>",
"name": "<string>"
}
],
"brands": [
{
"name": "<string>",
"slug": "<string>",
"websiteUrl": "<string>",
"twitterHandle": "<string>",
"includedTerms": "<string>",
"excludedTerms": "<string>",
"noOfficialAssets": [],
"officialAssets": [
"<string>"
]
}
]
}
'import requests
url = "https://app.chainpatrol.io/api/v2/staff/organization/create"
payload = {
"organization": {
"name": "<string>",
"slug": "<string>",
"accountExecName": "<string>",
"accountExecEmail": "jsmith@example.com",
"description": "<string>",
"websiteUrl": "<string>",
"twitterHandle": "<string>",
"avatarUrl": "<string>",
"subscriptionStatus": "PROSPECT",
"isReportingActive": True,
"isAutomatedReportingActive": True,
"isReviewingActive": True,
"isAutomatedReviewingActive": True,
"isProtectionActive": True,
"isAutomatedProtectionActive": True,
"isTakedownsActive": True,
"isDetectionActive": True,
"requiresCustomerReview": True
},
"owner": {
"fullName": "<string>",
"email": "jsmith@example.com",
"avatarUrl": "<string>"
},
"officialAssets": [
{
"content": "<string>",
"name": "<string>"
}
],
"brands": [
{
"name": "<string>",
"slug": "<string>",
"websiteUrl": "<string>",
"twitterHandle": "<string>",
"includedTerms": "<string>",
"excludedTerms": "<string>",
"noOfficialAssets": [],
"officialAssets": ["<string>"]
}
]
}
headers = {
"X-API-KEY": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
organization: {
name: '<string>',
slug: '<string>',
accountExecName: '<string>',
accountExecEmail: 'jsmith@example.com',
description: '<string>',
websiteUrl: '<string>',
twitterHandle: '<string>',
avatarUrl: '<string>',
subscriptionStatus: 'PROSPECT',
isReportingActive: true,
isAutomatedReportingActive: true,
isReviewingActive: true,
isAutomatedReviewingActive: true,
isProtectionActive: true,
isAutomatedProtectionActive: true,
isTakedownsActive: true,
isDetectionActive: true,
requiresCustomerReview: true
},
owner: {fullName: '<string>', email: 'jsmith@example.com', avatarUrl: '<string>'},
officialAssets: [{content: '<string>', name: '<string>'}],
brands: [
{
name: '<string>',
slug: '<string>',
websiteUrl: '<string>',
twitterHandle: '<string>',
includedTerms: '<string>',
excludedTerms: '<string>',
noOfficialAssets: [],
officialAssets: ['<string>']
}
]
})
};
fetch('https://app.chainpatrol.io/api/v2/staff/organization/create', 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://app.chainpatrol.io/api/v2/staff/organization/create",
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([
'organization' => [
'name' => '<string>',
'slug' => '<string>',
'accountExecName' => '<string>',
'accountExecEmail' => 'jsmith@example.com',
'description' => '<string>',
'websiteUrl' => '<string>',
'twitterHandle' => '<string>',
'avatarUrl' => '<string>',
'subscriptionStatus' => 'PROSPECT',
'isReportingActive' => true,
'isAutomatedReportingActive' => true,
'isReviewingActive' => true,
'isAutomatedReviewingActive' => true,
'isProtectionActive' => true,
'isAutomatedProtectionActive' => true,
'isTakedownsActive' => true,
'isDetectionActive' => true,
'requiresCustomerReview' => true
],
'owner' => [
'fullName' => '<string>',
'email' => 'jsmith@example.com',
'avatarUrl' => '<string>'
],
'officialAssets' => [
[
'content' => '<string>',
'name' => '<string>'
]
],
'brands' => [
[
'name' => '<string>',
'slug' => '<string>',
'websiteUrl' => '<string>',
'twitterHandle' => '<string>',
'includedTerms' => '<string>',
'excludedTerms' => '<string>',
'noOfficialAssets' => [
],
'officialAssets' => [
'<string>'
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-KEY: <api-key>"
],
]);
$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://app.chainpatrol.io/api/v2/staff/organization/create"
payload := strings.NewReader("{\n \"organization\": {\n \"name\": \"<string>\",\n \"slug\": \"<string>\",\n \"accountExecName\": \"<string>\",\n \"accountExecEmail\": \"jsmith@example.com\",\n \"description\": \"<string>\",\n \"websiteUrl\": \"<string>\",\n \"twitterHandle\": \"<string>\",\n \"avatarUrl\": \"<string>\",\n \"subscriptionStatus\": \"PROSPECT\",\n \"isReportingActive\": true,\n \"isAutomatedReportingActive\": true,\n \"isReviewingActive\": true,\n \"isAutomatedReviewingActive\": true,\n \"isProtectionActive\": true,\n \"isAutomatedProtectionActive\": true,\n \"isTakedownsActive\": true,\n \"isDetectionActive\": true,\n \"requiresCustomerReview\": true\n },\n \"owner\": {\n \"fullName\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"avatarUrl\": \"<string>\"\n },\n \"officialAssets\": [\n {\n \"content\": \"<string>\",\n \"name\": \"<string>\"\n }\n ],\n \"brands\": [\n {\n \"name\": \"<string>\",\n \"slug\": \"<string>\",\n \"websiteUrl\": \"<string>\",\n \"twitterHandle\": \"<string>\",\n \"includedTerms\": \"<string>\",\n \"excludedTerms\": \"<string>\",\n \"noOfficialAssets\": [],\n \"officialAssets\": [\n \"<string>\"\n ]\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-KEY", "<api-key>")
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://app.chainpatrol.io/api/v2/staff/organization/create")
.header("X-API-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"organization\": {\n \"name\": \"<string>\",\n \"slug\": \"<string>\",\n \"accountExecName\": \"<string>\",\n \"accountExecEmail\": \"jsmith@example.com\",\n \"description\": \"<string>\",\n \"websiteUrl\": \"<string>\",\n \"twitterHandle\": \"<string>\",\n \"avatarUrl\": \"<string>\",\n \"subscriptionStatus\": \"PROSPECT\",\n \"isReportingActive\": true,\n \"isAutomatedReportingActive\": true,\n \"isReviewingActive\": true,\n \"isAutomatedReviewingActive\": true,\n \"isProtectionActive\": true,\n \"isAutomatedProtectionActive\": true,\n \"isTakedownsActive\": true,\n \"isDetectionActive\": true,\n \"requiresCustomerReview\": true\n },\n \"owner\": {\n \"fullName\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"avatarUrl\": \"<string>\"\n },\n \"officialAssets\": [\n {\n \"content\": \"<string>\",\n \"name\": \"<string>\"\n }\n ],\n \"brands\": [\n {\n \"name\": \"<string>\",\n \"slug\": \"<string>\",\n \"websiteUrl\": \"<string>\",\n \"twitterHandle\": \"<string>\",\n \"includedTerms\": \"<string>\",\n \"excludedTerms\": \"<string>\",\n \"noOfficialAssets\": [],\n \"officialAssets\": [\n \"<string>\"\n ]\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.chainpatrol.io/api/v2/staff/organization/create")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"organization\": {\n \"name\": \"<string>\",\n \"slug\": \"<string>\",\n \"accountExecName\": \"<string>\",\n \"accountExecEmail\": \"jsmith@example.com\",\n \"description\": \"<string>\",\n \"websiteUrl\": \"<string>\",\n \"twitterHandle\": \"<string>\",\n \"avatarUrl\": \"<string>\",\n \"subscriptionStatus\": \"PROSPECT\",\n \"isReportingActive\": true,\n \"isAutomatedReportingActive\": true,\n \"isReviewingActive\": true,\n \"isAutomatedReviewingActive\": true,\n \"isProtectionActive\": true,\n \"isAutomatedProtectionActive\": true,\n \"isTakedownsActive\": true,\n \"isDetectionActive\": true,\n \"requiresCustomerReview\": true\n },\n \"owner\": {\n \"fullName\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"avatarUrl\": \"<string>\"\n },\n \"officialAssets\": [\n {\n \"content\": \"<string>\",\n \"name\": \"<string>\"\n }\n ],\n \"brands\": [\n {\n \"name\": \"<string>\",\n \"slug\": \"<string>\",\n \"websiteUrl\": \"<string>\",\n \"twitterHandle\": \"<string>\",\n \"includedTerms\": \"<string>\",\n \"excludedTerms\": \"<string>\",\n \"noOfficialAssets\": [],\n \"officialAssets\": [\n \"<string>\"\n ]\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"organization": {
"id": 123,
"name": "<string>",
"slug": "<string>",
"description": "<string>",
"websiteUrl": "<string>",
"subscriptionStatus": "POC",
"createdAt": "<string>"
},
"owner": {
"id": 123,
"email": "<string>",
"fullName": "<string>"
},
"brands": [
{
"id": 123,
"name": "<string>"
}
],
"brandAssetErrors": [
{
"brandName": "<string>",
"message": "<string>"
}
],
"skippedAssets": [
{
"content": "<string>",
"brandName": "<string>",
"reason": "<string>"
}
],
"dashboardUrl": "<string>"
}{
"code": "BAD_REQUEST",
"message": "Invalid input data",
"issues": []
}{
"code": "UNAUTHORIZED",
"message": "Authorization not provided",
"issues": []
}{
"code": "FORBIDDEN",
"message": "Insufficient access",
"issues": []
}{
"code": "INTERNAL_SERVER_ERROR",
"message": "Internal server error",
"issues": []
}403 Forbidden.Overview
Create a new customer organization exactly as ChainPatrol staff do from Staff → Organizations → Create in the app. In one call it:- creates the organization with the services you enable
- adds the owner (reusing an existing user with that email) as
OWNER, and the calling staff user asADMIN - creates the default asset groups and any initial brands
- creates the website as a monitored asset and allowlists it, together with any official assets you list
Authentication
Authenticate with a staff user API key in theX-API-KEY header, or a
staff session token as Authorization: Bearer <token>. Organization API keys,
customer users, and read-only staff service accounts are refused.
Example Request
curl -X POST 'https://app.chainpatrol.io/api/v2/staff/organization/create' \
-H 'X-API-KEY: YOUR_STAFF_API_KEY' \
-H 'Content-Type: application/json' \
-d '{
"organization": {
"name": "Acme",
"slug": "acme",
"websiteUrl": "https://acme.com",
"twitterHandle": "@acme",
"subscriptionStatus": "PROSPECT",
"accountExecName": "Jane Doe",
"accountExecEmail": "jane@chainpatrol.io",
"isReportingActive": true,
"isReviewingActive": true,
"isDetectionActive": true,
"requiresCustomerReview": true
},
"owner": {
"fullName": "John Smith",
"email": "john@acme.com"
},
"brands": [
{
"name": "Acme",
"slug": "acme",
"type": "ORGANIZATION",
"includedTerms": "*acme*",
"officialAssets": ["https://twitter.com/acme"]
}
]
}'
const response = await fetch(
"https://app.chainpatrol.io/api/v2/staff/organization/create",
{
method: "POST",
headers: {
"Content-Type": "application/json",
"X-API-KEY": "YOUR_STAFF_API_KEY",
},
body: JSON.stringify({
organization: {
name: "Acme",
slug: "acme",
websiteUrl: "https://acme.com",
accountExecName: "Jane Doe",
accountExecEmail: "jane@chainpatrol.io",
},
owner: { fullName: "John Smith", email: "john@acme.com" },
}),
}
);
const data = await response.json();
console.log(data.dashboardUrl);
Response
{
"organization": {
"id": 1234,
"name": "Acme",
"slug": "acme",
"description": null,
"websiteUrl": "https://acme.com",
"subscriptionStatus": "PROSPECT",
"createdAt": "2026-10-15T12:00:00.000Z"
},
"owner": {
"id": 5678,
"email": "john@acme.com",
"fullName": "John Smith"
},
"brands": [{ "id": 91, "name": "Acme" }],
"brandAssetErrors": [],
"skippedAssets": [],
"dashboardUrl": "https://app.chainpatrol.io/admin/acme/dashboard"
}
skippedAssets lists assets that were not added or allowlisted because they
are currently blocked, for example a known scam domain passed as an official
asset. Review them before allowlisting anything by hand.
brandAssetErrors lists brands whose official assets could not be added. The
organization and its brands are still created; add those assets again from the
app or the Add Organization Assets
endpoint.
Errors
| Status | When |
|---|---|
400 | Validation failed, e.g. an invalid Twitter handle, unsupported asset, or brand term conflict. The message names the field. |
401 | No API key or session was provided. |
403 | The caller is not ChainPatrol staff, or the credential is read-only. |
409 | The organization slug or a brand slug is taken, or the website already belongs to another organization. |
Notes
- The request is validated with the same rules as the app’s create form, so anything the app refuses is refused here too.
- Omitted settings take the app form’s defaults: reporting, reviewing and
detection on, customer review off, and subscription status
PROSPECT. Other services stay off unless you enable them. - Enabling an automated service (for example
isAutomatedReviewingActive) requires its manual counterpart (isReviewingActive). - Official assets already owned by another organization are skipped rather than reassigned.
- Assets that are currently blocked are never added to the organization or
allowlisted, whether they come in as the website,
officialAssetsor a brand’sofficialAssets. They are listed inskippedAssetsinstead, and the organization is still created.
Authorizations
Your API key. This is required by most endpoints to access our API programatically. Reach out to us at support@chainpatrol.io to get an API key for your use.
Body
Create an organization (staff only)
Creates an organization exactly as ChainPatrol staff do from the app: the owner and the calling staff user are added as members, default asset groups and any initial brands are created, and the website and official assets are allowlisted.
Only ChainPatrol staff can call this endpoint, with a staff session or a staff user API key. Organization API keys and customer accounts receive 403.
Response
Successful response
Successful operation
Was this page helpful?