Skip to main content
POST
/
v1
/
companies
Create or update company
curl --request POST \
  --url https://api.stardex.ai/v1/companies \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "domain": "<string>",
  "linkedin_url": "<string>",
  "description": "<string>",
  "location": "<string>",
  "phone": "<string>",
  "is_client": true,
  "custom_fields": [
    {
      "attribute_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "value": "<string>",
      "add_values": [
        "<string>"
      ],
      "remove_values": [
        "<string>"
      ],
      "add_team_member_ids": [
        "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      ],
      "remove_team_member_ids": [
        "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      ],
      "clear_all": true
    }
  ]
}
'
{
  "success": true,
  "data": {
    "id": "456e7890-e12b-34d5-a678-901234567890",
    "name": "Acme Corp",
    "domain": "acme.com",
    "linkedin_url": "https://www.linkedin.com/company/acme",
    "linkedin_id": 12345678,
    "location": "San Francisco, CA",
    "phone": "+1-555-0100",
    "description": "Leading technology solutions provider specializing in enterprise SaaS.",
    "is_client": true,
    "do_not_contact": false,
    "do_not_contact_metadata": null,
    "created_at": "2024-01-05T10:00:00Z",
    "date_of_last_engagement": "2024-06-15T14:30:00Z",
    "client_status": {
      "id": "789e0123-e45f-67a8-b901-234567890123",
      "name": "Active"
    },
    "enriched_company": {
      "id": "ec123456-7890-abcd-ef01-234567890abc",
      "name": "Acme Corp",
      "domain": "acme.com",
      "linkedin_url": "https://www.linkedin.com/company/acme"
    },
    "owners": [
      {
        "id": "234e5678-e90a-12b3-c456-789012345678",
        "first_name": "Jane",
        "last_name": "Smith"
      }
    ],
    "custom_fields": [
      {
        "attribute_id": "e5f6a7b8-c9d0-1234-efab-567890123456",
        "attribute_name": "Industry",
        "data_type": "single-select",
        "value": null,
        "tag": {
          "id": "f6a7b8c9-d0e1-2345-fabc-678901234567",
          "name": "Technology"
        },
        "team_member": null
      },
      {
        "attribute_id": "a7b8c9d0-e1f2-3456-abcd-789012345678",
        "attribute_name": "Account Owner",
        "data_type": "multi-team-member",
        "value": null,
        "tag": null,
        "team_member": {
          "id": "234e5678-e90a-12b3-c456-789012345678",
          "name": "Jane Smith"
        }
      }
    ]
  }
}

Authorizations

Authorization
string
header
required

Authenticate with a Bearer token: API key, OAuth token, or session token.

Body

application/json
name
string

Company name.

domain
string

Website domain.

linkedin_url
string

LinkedIn company page URL.

description
string

Company description.

location
string

Company headquarters location.

phone
string

Company phone number.

is_client
boolean

Whether to mark the company as a client.

custom_fields
object[]

Custom field values to set. Get attribute definitions from GET /v1/custom-fields/companies.

Response

Company created or updated

success
enum<boolean>
required
Available options:
true
data
object
required