POST
/
customerbase
/
v1
/
organizations
curl --request POST \
  --url https://api.customeros.ai/customerbase/v1/organizations \
  --header 'Content-Type: application/json' \
  --header 'X-CUSTOMER-OS-API-KEY: <api-key>' \
  --data '{
  "customId": "<string>",
  "icpFit": true,
  "leadSource": "<string>",
  "linkedinUrl": "<string>",
  "name": "<string>",
  "relationship": "<string>",
  "website": "<string>"
}'
{
  "organization": {
    "cosId": "<string>",
    "customId": "<string>",
    "domains": [
      "<string>"
    ],
    "externalLinks": [
      {
        "id": "<string>",
        "name": "<string>",
        "primary": true
      }
    ],
    "icpFit": true,
    "id": "<string>",
    "leadSource": "<string>",
    "name": "<string>",
    "relationship": "<string>",
    "stage": "<string>",
    "website": "<string>"
  },
  "requestId": "1234567890abcdef",
  "status": "success"
}

Authorizations

​
X-CUSTOMER-OS-API-KEY
string
header
required

Body

application/json
Organization creation request

Request to create an organization

​
customId
string

Custom ID provided by the user example: 12345

​
icpFit
boolean

Indicates if the organization is an ICP (Ideal Customer Profile) fit example: true

​
leadSource
string

Lead source of the organization example: Web Search

​
linkedinUrl
string

Organization's LinkedIn profile URL example: https://linkedin.com/company/openline

​
name
string

Organization's name required: true example: CustomerOS

​
relationship
string

Relationship status of the organization example: customer

​
website
string

Organization's website URL example: https://customeros.ai

Response

201
application/json
Organization created successfully

Response structure for single organization operations

​
organization
object

The organization information

​
requestId
string
Example:

"1234567890abcdef"

​
status
string

Status indicates the result of the operation ("success" or "error")

Example:

"success"