POST
/
v2
/
user
curl --request POST \
     --url {{BASE_URL}}/v2/user/ \
     --header 'Accept: application/json' \
     --header 'x-vital-api-key: <API_KEY>' \
     --header 'Content-Type: application/json' \
     --data '
{
     "client_user_id": "your_unique_id"
}
'
{
  "client_user_id": "5269f80a-fb0b-432a-b311-c3eac1a46260",
  "user_id": "e209947b-323e-4108-8e18-1518b80da0bd"
}

When the supplied client_user_id conflicts with an existing user, the 400 Bad Request error response includes the Vital User ID (user_id) and the creation date (created_on) of the conflicting user.

Authorizations

x-vital-api-key
string
headerrequired

Vital Team API Key

Body

application/json
client_user_id
string
required

A unique ID representing the end user. Typically this will be a user ID from your application. Personally identifiable information, such as an email address or phone number, should not be used in the client_user_id.

fallback_time_zone
string
Fallback time zone of the user, in the form of a valid IANA tzdatabase identifier (e.g., `Europe/London` or `America/Los_Angeles`).
Used when pulling data from sources that are completely time zone agnostic (e.g., all time is relative to UTC clock, without any time zone attributions on data points).
fallback_birth_date
string

Fallback date of birth of the user, in YYYY-mm-dd format. Used for calculating max heartrate for providers that don not provide users' age.

ingestion_start
string

Starting bound for user data ingestion. Data older than this date will not be ingested.

ingestion_end
string

Ending bound for user data ingestion. Data from this date or later will not be ingested and the connection will be deregistered.

Response

200 - application/json
user_id
string
required

User id returned by vital create user request. This id should be stored in your database against the user and used for all interactions with the vital api.

client_user_id
string
required

A unique ID representing the end user. Typically this will be a user ID from your application. Personally identifiable information, such as an email address or phone number, should not be used in the client_user_id.