User
Refresh User Data
User
Refresh User Data
Trigger a manual refresh for a specific user
POST
/
v2
/
user
/
refresh
/
{user_id}
Authorization
Path
curl --request POST \
--url {{BASE_URL}}/v2/user/refresh/{user_id} \
--header 'Accept: application/json' \
--header 'x-vital-api-key: <API_KEY>'
{
"success": true,
"user_id": "55c39ede-16b8-438f-bbb9-62591dc2400e",
"refreshed_sources": [
"Withings/workouts",
"Withings/sleep",
"Withings/body",
"Withings/vitals/blood_pressure",
"Withings/activity"
],
"failed_sources": ["Oura/sleep"]
}
Authorizations
x-vital-api-key
string
headerrequiredAPI key based authentication
Path Parameters
user_id
string
requiredResponse
200 - application/json
failed_sources
string[]
requiredrefreshed_sources
string[]
requiredsuccess
boolean
requiredWhether operation was successful or not
user_id
string
requiredA 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.
curl --request POST \
--url {{BASE_URL}}/v2/user/refresh/{user_id} \
--header 'Accept: application/json' \
--header 'x-vital-api-key: <API_KEY>'
{
"success": true,
"user_id": "55c39ede-16b8-438f-bbb9-62591dc2400e",
"refreshed_sources": [
"Withings/workouts",
"Withings/sleep",
"Withings/body",
"Withings/vitals/blood_pressure",
"Withings/activity"
],
"failed_sources": ["Oura/sleep"]
}