Skip to main content
POST
/
v1
/
companies
/
identify
Identify Company
curl --request POST \
  --url https://{environment}.userpilot.io/v1/companies/identify \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "company_id": "<string>",
  "metadata": {
    "custom_company_property": "<string>"
  }
}
'
{}

Headers

​
Content-Type
string
default:application/json
​
Accept
string
default:application/json
​
Authorization
string
default:Token ABC_1234_EFGH_5678
required

API authentication token in the format: Token {{API_KEY}} Obtain your API key from the Userpilot Environment Settings.

Body

application/json
​
company_id
string
required

The unique identifier for the company. This is the ID that Userpilot uses to identify the company.

​
metadata
object

Optional company metadata. You can add, remove, or modify any properties as needed for your use case.

Response

Accepted - Company identification successful