title	timeCard: startBreak
description	Start break in a specific timecard.
author	akumar39
ms.date	04/05/2024
ms.localizationpriority	medium
ms.subservice	teams
doc_type	apiPageType

timeCard: startBreak

Namespace: microsoft.graph

[!INCLUDE beta-disclaimer]

Start a break in a specific timeCard.

[!INCLUDE national-cloud-support]

Permissions

Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions only if your app requires it. For details about delegated and application permissions, see Permission types. To learn more about these permissions, see the permissions reference.

[!INCLUDE permissions-table]

HTTP request

POST /teams/{teamId}/schedule/timeCards/{timeCardID}/startBreak

Request headers

Header	Value
Authorization	Bearer {token}. Required. Learn more about authentication and authorization.
Content-type	application/json. Required.
MS-APP-ACTS-AS (deprecated)	A user ID (GUID). Required only if the authorization token is an application token; otherwise, optional. The `MS-APP-ACTS-AS` header is deprecated and no longer required with application tokens.

Request body

In the request body, provide a JSON object with the following parameters.

Parameter	Type	Description
isAtApprovedLocation	Boolean	Indicates whether this action happens at an approved location.
notes	itemBody	Notes for the start of the break.
atApprovedLocation (deprecated)	Boolean	Indicates whether this action happens at an approved location. This property will be removed by November 27, 2027. Use `isAtApprovedLocation` instead. `atApprovedLocation` and `isAtApprovedLocation` always have the same value, so setting one automatically sets the value for the other. If both are included in the request with different values, the value for `isAtApprovedLocation` takes precedence.

Response

If successful, this method returns a 204 No Content response code.

Example

Request

The following example shows a request.

HTTP

POST https://graph.microsoft.com/beta/teams/fd15cad8-80f6-484f-9666-3caf695fbf32/schedule/timeCards/TCK_cc09588d-d9d2-4fa0-85dc-2aa5ef983972/startbreak
Content-type: application/json

{
    "isAtApprovedLocation": true,
    "notes": {
        "contentType": "text",
        "content": "starting break"
    }
}