Vitally

Replace <code>{subdomain}</code> 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

<code>POST</code> <code>https://{subdomain}.api.vitally.io/analytics/v1/user</code>

This endpoint will create or update a user in Vitally based on the <code>userId</code> parameter.

200 When your user is created/updated, you'll receive

An example curl request describing a Vitally user would look like:

curl -X POST https://{subdomain}.api.vitally.io/analytics/v1/user \ -H "Authorization: Basic [your token]" \ -H "Content-Type: application/json" \ -d '{ "userId": "32", "accountId": "123456", "traits": { "name": "Lionel Messi", "position": "Forward", "email": "messi@barcelona.sp" }, "messageId": "7ac1c682-a54b-4d0d-9f56-d6d3618f4915", "timestamp": "2018-05-15T12:31:12.123Z" }'

Vitally has special logic to handle the following User traits:

<code>name</code>: defines the user's name in Vitally

<code>avatar</code>: defines the user's avatar in Vitally

<code>email</code>: defines the user's email in Vitally

<code>createdAt</code>: defines the user's 'join date' in Vitally

- <code>name</code>: defines the user's name in Vitally
- <code>avatar</code>: defines the user's avatar in Vitally
- <code>email</code>: defines the user's email in Vitally
- <code>createdAt</code>: defines the user's 'join date' in Vitally

Create/update your Users in Vitally using the /user API endpoint

Vitally's HTTPS Analytics API - User

Find answers and get help from Intercom Support and Community Experts

This site employs cookies and other technologies that we and our third party vendors use to monitor and record personal information about you and your interactions with the site (including content viewed, cursor movements, screen recordings, and chat contents) for the purposes described in our Cookie Policy. By continuing to visit our site, you agree to our {websiteTermsLink}, {privacyPolicyLink} and {cookiePolicyLink}.

This site uses cookies and similar technologies ("cookies") as strictly necessary for site operation. We and our partners also would like to set additional cookies to enable site performance analytics, functionality, advertising and social media features. See our {cookiePolicyLink} for details. You can change your cookie preferences in our Cookie Settings.

We use cookies to make our site work and also for analytics and advertising purposes. You can enable or disable optional cookies as desired. See our {cookiePolicyLink} for more details.

Advertising cookies are set by our advertising partners to collect information about your use of the site, our communications, and other online services over time and with different browsers and devices. They use this information to show you ads online that they think will interest you and measure the ads' performance. Social media cookies are set by social media platforms to enable you to share content on those platforms, and are capable of tracking information about your activity across other online services for use as described in their privacy policies.

These cookies enable the website to provide enhanced functionality and personalisation. They may be set by us or by third party providers whose services we have added to our pages. If you do not allow these cookies then some or all of these services may not function properly.

These cookies are necessary for the website to function and cannot be switched off in our systems.

These cookies allow us to count visits and traffic sources so we can measure and improve the performance of our site. They help us to know which pages are the most and least popular and see how visitors move around the site.

You have the right to opt out of the sale of your personal information. See our {cookiePolicyLink} for more details about how we use your data.

Your Privacy Choices

We use cookies to enhance your experience. You can customize your cookie preferences below. See our {cookiePolicyLink} for more details.

Cookie Settings

Link, Press control-option-right-arrow to exit

Empty Help Center

Uh oh. That page doesn’t exist.

Disappointed

Neutral

Smiley

Thinking...

Searching through sources...

Analyzing...

Tickets submitted through the messenger or by a support agent in your conversation will appear here.

Name	Type	Description
Content-Type*	string	Set to `application/json`
Authorization*	string	Set to `Basic [YOUR_API_TOKEN]`

Name	Type	Description
userId*	string	The unique ID of this user in your system
accountId	string	Required if `organizationId` is not included. This should match the `accountId` you send in your account request
traits*	object	Required, but can be passed as an empty object `"traits": {}` A JSON object containing the traits of this user. Some traits, called "reserved" traits, have special meaning to Vitally. A list of "reserved" traits can be found below.
timestamp	string	Required if `messageId` is not included. An ISO 8601 UTC date string - i.e. `'2018-01-01T00:00:00Z'` - for the time the message was sent. If `timestamp` is not included, it will default to the time the API server receives your message.
messageId	string	Required if `timestamp` is not included. A unique ID for this message, used to de-duplicate messages. We recommend sending `messageId`, but if it is not included and `timestamp` is included, it will be set to a hash of the message.
organizationId	string	Required if `accountId` is not included. If you have organizations enabled, you may associate the user with an organization by setting `organizationId`

Vitally's HTTPS Analytics API - User

Create/update a user

Headers

Request Body

Example

Special traits