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.

POST /staff/organization/create

Create an organization (staff only)

cURL

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": "[e-mail]",
    "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": false
  },
  "owner": {
    "fullName": "<string>",
    "email": "[e-mail]",
    "avatarUrl": "<string>"
  },
  "officialAssets": [
    {
      "content": "<string>",
      "name": "<string>"
    }
  ],
  "brands": [
    {
      "name": "<string>",
      "slug": "<string>",
      "websiteUrl": "<string>",
      "twitterHandle": "<string>",
      "includedTerms": "<string>",
      "excludedTerms": "<string>",
      "noOfficialAssets": [],
      "officialAssets": [
        "<string>"
      ]
    }
  ]
}
'

200

{
  "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>"
}

This endpoint is only available to ChainPatrol staff. Customer API keys and customer accounts receive 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 as ADMIN
• 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 the X-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

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": "[e-mail]",
      "isReportingActive": true,
      "isReviewingActive": true,
      "isDetectionActive": true,
      "requiresCustomerReview": true
    },
    "owner": {
      "fullName": "John Smith",
      "email": "[e-mail]"
    },
    "brands": [
      {
        "name": "Acme",
        "slug": "acme",
        "type": "ORGANIZATION",
        "includedTerms": "*acme*",
        "officialAssets": ["https://twitter.com/acme"]
      }
    ]
  }'

​

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": "[e-mail]",
    "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, officialAssets or a brand’s officialAssets. They are listed in skippedAssets instead, and the organization is still created.

Authorizations

X-API-KEY · string · header · required

Your API key. This is required by most endpoints to access our API programatically. Reach out to us at [e-mail] to get an API key for your use.

Body

application/json

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.

organization · object · required

The organization to create

Show child attributes

owner · object · required

The customer user who owns the organization

Show child attributes

officialAssets · object[]

Official assets of the organization not tied to a brand. Each is created (or claimed when unowned) and allowlisted. Assets owned by another organization are skipped, and currently BLOCKED assets are skipped and reported in skippedAssets

Show child attributes

brands · object[]

Initial brands. When provided, at least one is required

Minimum array length: 1

Show child attributes

Response

200

application/json

Successful response

Successful operation

organization · object · required

Show child attributes

owner · object · required

Show child attributes

brands · object[] · required

Brands created with the organization

Show child attributes

brandAssetErrors · object[] · required

Brands whose official assets could not be added. The organization and brands were still created; add the assets again from the app or API

Show child attributes

skippedAssets · object[] · required

Website and official assets that were not added or allowlisted because they are currently BLOCKED. The organization was still created; review these assets before allowlisting them

Show child attributes

dashboardUrl · string · required

Link to the organization's dashboard