Skip to main content
POST
/
v2
/
user
/
refresh
/
{user_id}
curl --request POST \
     --url {{BASE_URL}}/v2/user/refresh/{user_id} \
     --header 'Accept: application/json' \
     --header 'x-vital-api-key: <API_KEY>'

{
  "failed_sources": [
    "oura/sleep"
  ],
  "in_progress_sources": [],
  "refreshed_sources": [
    "withings/workouts",
    "withings/sleep",
    "withings/body",
    "withings/vitals/blood_pressure",
    "withings/activity"
  ],
  "success": true,
  "user_id": "1449752e-0d8a-40e0-9206-91ab099b2537"
}
curl --request POST \
     --url {{BASE_URL}}/v2/user/refresh/{user_id} \
     --header 'Accept: application/json' \
     --header 'x-vital-api-key: <API_KEY>'

Authorizations

​
x-vital-api-key
string
header
required

Vital Team API Key

Path Parameters

​
user_id
string<uuid>
required

Query Parameters

​
timeout
number
default:10
Required range: 5 <= x <= 60

Response

Successful Response

​
success
boolean
required

Whether operation was successful or not

​
user_id
string<uuid>
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.

​
refreshed_sources
string[]
required
​
in_progress_sources
string[]
required
​
failed_sources
string[]
required