Create Activity Goal
chevron down
back search icon cancel search
 
 

Create Activity Goal

Creates or updates a user's daily or weekly activity goal.

It uses units that correspond to the Accept-Language header provided.

Scope: activity

Request

POST /1/user/[user-id]/activities/goals/[period].json

URI Arguments
user-id required The encoded ID of the user. Use "-" (dash) for current logged-in user.
period required Supported: daily | weekly

Query Parameters
type optional/required Supported: activeMinutes | activeZoneMinutes | caloriesOut | distance | floors | steps string
value optional/required Goal value integer

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/-/activities/goals/daily.json?type=steps&value=10000
POST https://api.fitbit.com/1/user/GGNJL9/activities/goals/daily.json?type=steps&value=10000
curl -X POST "https://api.fitbit.com/1/user/-/activities/goals/daily.json?type=steps&value=10000" \
-H "accept: application/json" \
-H "authorization: Bearer <access_token>" \
-H "content-length: <message_body_size>"

Response

Element Name Description
goals : activeMinutes Daily active minutes goal. A value is not returned for weekly goals.
goals : activeZoneMinutes Daily or weekly active zone minutes goal.
goals : caloriesOut Daily calories burned goal. A value is not returned for weekly goals.
goals : distance Daily or weekly distance goal.
goals : floors Daily or weekly floors climbed goal.
goals : steps Daily or weekly steps taken goal.

The following is an example of a response for daily activity goals.

{
    "goals": {
        "activeMinutes": 55,
        "activeZoneMinutes": 21,
        "caloriesOut": 3500,
        "distance": 5,
        "floors": 10,
        "steps": 10000
    }
}

The following is an example of a response for weekly activity goals.

{
    "goals": {
        "activeZoneMinutes": 150,
        "distance": 56.33,
        "floors": 70,
        "steps": 70000
    }
}

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.

Additional Information

The response uses the measurement units as defined in the unit system, which corresponds to the Accept-Language header provided.

Create Activity Log
next