Create Weight Goal
chevron down
 

Create Weight Goal

Creates or updates a user's weight goal.

Scope: weight


Request

POST /1/user/[user-id]/body/log/weight/goal.json

URI Arguments
user-id required The encoded ID of the user. Use "-" (dash) for current logged-in user.

Query Parameters
startDate required Weight goal start date in the format yyyy-MM-dd. decimal
startWeight required Starting weight before reaching goal in the format X.XX; entered in the unit system corresponding to the Accept-Language header provided. decimal
weight optional/required Target weight goal in the format X.XX; entered in the unit system corresponding to the Accept-Language header provided. Required if the user doesn't have an existing weight goal. decimal

Request Headers

authorization required Specify the token type and Fitbit user’s access token.
Token type: Bearer
accept optional The media type of the response content the client is expecting.
Supported: application/json
accept-language optional The measurement unit system to use for response values. See Localization.
accept-locale optional The locale to use for response values. See Localization.
content-length required According to RFC 7230, section 3.3.2, this HTTP request requires the Content-Length header field containing the anticipated size of the payload body.

Examples
POST https://api.fitbit.com/1/user/-/body/log/weight/goal.json?startDate=2019-03-21&startWeight=200&weight=180.5
POST https://api.fitbit.com/1/user/GGNJL9/body/log/weight/goal.json?startDate=2019-03-21&startWeight=200&weight=180.5
curl -X POST "https://api.fitbit.com/1/user/-/body/log/weight/goal.json?startDate=2019-03-21&startWeight=200" \
-H "accept: application/json" \
-H "authorization: Bearer <access_token>" \
-H "content-length: <message_body_size>"


Response

Element Name Description
goal : goalType The goal type.
Supported: LOSE | GAIN | MAINTAIN
goal : startDate The goal start date.
goal : startWeight User's weight when goal was established.
goal : weight The weight goal to achieve.
goal : weightThreshold The recommended amount of weight to lose each week to achieve and maintain goal.
{
  "goal": {
    "goalType": "LOSE",
    "startDate": "2019-03-21",
    "startWeight": 200,
    "weight": 180.5,
    "weightThreshold": 0.05
  }
}
      

Response Headers
content-type The media type of the response content being sent to the client.
Supported: application/json
fitbit-rate-limit-limit The quota number of calls.
fitbit-rate-limit-remaining The number of calls remaining before hitting the rate limit.
fitbit-rate-limit-reset The number of seconds until the rate limit resets.

Note: The rate limit headers are approximate and asynchronously updated. This means that there may be a minor delay in the decrementing of remaining requests. This could result in your application receiving an unexpected 429 response if you don't track the total number of requests you make yourself.

Response Type

HTTP Status Code HTTP response code. List of codes are found in the Troubleshooting Guide.
Status Message Description of the status code.
Response Body Contains the JSON response to the API call. When errors are returned by the API call, the errorType, fieldName and message text will provide more information to the cause of the failure.

Response Codes
201 A successful request.
400 The request had bad syntax or was inherently impossible to be satisfied.
401 The request requires user authentication.

Note: For a complete list of response codes, please refer to the Troubleshooting Guide.