Delete Subscription

Deletes a subscription for a specific user. See Deleting a Subscription for more information.

Scope: See collection-path URI Argument

Request

DELETE

/1/user/[user-id]/[collection-path]/apiSubscriptions/[subscription-id].json

URI Arguments

user-id	required	The encoded ID of the user. Use "-" (dash) for current logged-in user.
collection-path	optional	Collection of data to retrieve notifications. If not provided, a subscription will be deleted for all collections. Supported: `activities` \| `body` \| `foods` \| `sleep` \| `userRevokedAccess` The user must consent to the proper OAuth 2.0 scope before a subscription can be created for the collection. The list of requirements are: `activities` collection requires `activity` scope. `body` collection requires `weight` scope. `foods` collection requires `nutrition` scope. `sleep` collection requires `sleep` scope. `userRevokedAccess` collection does not require any scopes. If no collection specified, `activity`, `nutrition`, `profile`, `settings`, `sleep`, `weight` scopes are required.
subscription-id	required	The unique ID of the subscription created by the API client application. The value provides a way to associate an update with a particular user stream in your application. Maximum length: 50 characters

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.
X-Fitbit-Subscriber-Id	optional	The ID of the subscriber to receive notifications, as defined on dev.fitbit.com. If not present, the default subscriber is used.

Examples

URL
CURL

DELETE https://api.fitbit.com/1/user/-/apiSubscriptions/320.json
DELETE https://api.fitbit.com/1/user/-/activities/apiSubscriptions/320json
DELETE https://api.fitbit.com/1/user/-/body/apiSubscriptions/320.json
DELETE https://api.fitbit.com/1/user/-/foods/apiSubscriptions/320.json
DELETE https://api.fitbit.com/1/user/GGNJL9/sleep/apiSubscriptions/320.json
DELETE https://api.fitbit.com/1/user/GGNJL9/userRevokedAccess/apiSubscriptions/320.json

curl -X DELETE "https://api.fitbit.com/1/user/-/apiSubscriptions/320.json" \
-H "accept: application/json" \
-H "authorization: Bearer <access_token>"
curl -X DELETE "https://api.fitbit.com/1/user/-/activities/apiSubscriptions/320.json" \
-H "accept: application/json" \
-H "authorization: Bearer <access_token>"

Response

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

204	Returned if the given user is already subscribed to to the stream.

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

Create Subscription

Get Subscription List