Create Food Goal

Creates or updates a user's daily calorie consumption or food plan goals.

Scope: nutrition

Request

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

URI Arguments

user-id

required

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

Query Parameters

calories	optional/required	Manual calories consumption goal. Either `calories` or `intensity` must be provided.	integer
intensity	optional/required	Food plan intensity. Either `calories` or `intensity` must be provided. Supported: `MAINTENANCE` \| `EASIER` \| `MEDIUM` \| `KINDAHARD` \| `HARDER`	string
personalized	optional	Food plan type. Supported: `true` \| `false`	boolean

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

URL
CURL

POST https://api.fitbit.com/1/user/-/foods/log/goal.json?calories=1800
POST https://api.fitbit.com/1/user/GGNJL9/foods/log/goal.json?calories=1800

curl -X POST "https://api.fitbit.com/1/user/-/foods/log/goal.json?calories=1800" \
-H "accept: application/json" \
-H "authorization: Bearer <access_token>" \
-H "content-length: <message_body_size>"

Element Name	Description
goals : calories	The user's daily caloric consumption goal.
foodPlan : estimatedDate	Estimated weight goal achievement date based on current body metrics and food plan intensity values specified. Returned when the `intensity` query parameter is provided.
foodPlan : intensity	Food plan intensity value. Returned when the `intensity` query parameter is provided. Supported: `MAINTENANCE` \| `EASIER` \| `MEDIUM` \| `KINDAHARD` \| `HARDER`
foodPlan : personalized	States if the food plan is personalized for the user. Returned when the `intensity` query parameter is provided. Supported: `true` \| `false`	boolean

{
  "goals": {
    "calories": 1800
  }
}

or

{
  "foodPlan": {
    "estimatedDate": "2023-01-01",
    "intensity": "HARDER",
    "personalized": true
  },
  "goals": {
    "calories": 2200
  }
}

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 food plan exists only if user already has an active weight goal created via the Create Weight Goal endpoint.

Create Food

Create Food Log