Analytics API - Account
Create/update your (business) Accounts in Vitally using the /account API endpoint
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 account
POST
https://{subdomain}.api.vitally.io/analytics/v1/account
This endpoint will create or update an account in Vitally based on the accountId
parameter.
Headers
Name | Type | Description |
---|---|---|
Content-Type* | string | Set to |
Authorization* | string | Set to |
Request Body
Name | Type | Description |
---|---|---|
accountId* | string | The unique ID of this account in your system |
traits | object | A JSON object containing the traits of this account. All account messages should specify, at minimum, a |
timestamp | string | Required if |
messageId | string | Required if |
organizationId | string | If you have organizations enabled, you may associate the account with an organization by providing organizationId |
Expand the POST box above for full specs
Example
An example curl
request describing Vitally would look like:
Special traits
Vitally has special logic to handle the following Account traits:
name
: defines the account's name in Vitallyavatar
: defines the account's avatar in Vitally
Last updated