Replace {subdomain}
in the endpoint below with your Vitally subdomain.
You can find your subdomain in the URL used to log into Vitally (i.e., https://yoursubdomain.vitally.io
Create/update an organization
POST
https://{subdomain}.api.vitally.io/analytics/v1/organization
This endpoint will create or update an organization in Vitally based on the organizationId
parameter. It is only supported for Vitally accounts that have organizations enabled.
Headers
Name | Type | Description |
Content-Type* | string | Set to |
Authorization* | string | Set to |
Request Body
Name | Type | Description |
organizationId* | string | The unique ID of this organization in your system |
traits | object | A JSON object containing the traits of this organization. |
timestamp | string | Required if |
messageId | string | Required if |
200: OK When your organization is created/updated, you'll receive
{"message":"Success."}
Example
An example curl
request for creating an "IBM" organization would look like:
curl -X POST https://{subdomain}.api.vitally.io/analytics/v1/organization \
-H "Authorization: Basic [your token]" \
-H "Content-Type: application/json" \
-d '{
"organizationId": "123456",
"traits": {
"name": "IBM",
"avatar": "http://logo.clearbit.com/ibm.com",
"arr": 100000
},
"messageId": "7ac1c682-a54b-4d0d-9f56-d6d3618f4915",
"timestamp": "2018-05-15T12:31:12.123Z"
}'
Special traits
Vitally has special logic to handle the following Organization traits:
name
: defines the organization's name in Vitallyavatar
: defines the organization's avatar in Vitally