Edit

Create customFieldValue

Namespace: microsoft.graph

Important

APIs under the /beta version in Microsoft Graph are subject to change. Use of these APIs in production applications is not supported. To determine whether an API is available in v1.0, use the Version selector.

Create a new customFieldValue object.

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.

Permission type Least privileged permission Higher privileged permissions
Delegated (work or school account) Not supported. Not supported.
Delegated (personal Microsoft account) Not supported. Not supported.
Application Not supported. Not supported.

HTTP request

POST /users/{usersId}/planner/plans_v2/{planId}/tasks/{taskId}/customFieldValues

Request headers

Name Description
Authorization Bearer {token}. Required. Learn more about authentication and authorization.
Content-Type application/json. Required.

Request body

In the request body, supply a JSON representation of the customFieldValue object.

You can specify the following properties when creating a customFieldValue.

Property Type Description
customFieldDefinitionId String ID of the customFieldDefinition this value is for. Immutable after creation. Optional.
value String The value of the custom field, formatted according to the field's valueType. Optional.

Response

If successful, this method returns a 201 Created response code and a customFieldValue object in the response body.

Examples

Request

The following example shows a request.

POST https://graph.microsoft.com/beta/users/{usersId}/planner/plans_v2/{planId}/tasks/{taskId}/customFieldValues
Content-Type: application/json

{
  "@odata.type": "#microsoft.graph.customFieldValue",
  "customFieldDefinitionId": "d7f4b8a2-6c31-4d9a-8f21-2b6a9d4e7c31",
  "value": "42500"
}

Response

The following example shows the response.

Note: The response object shown here might be shortened for readability.

HTTP/1.1 201 Created
Content-Type: application/json

{
  "@odata.type": "#microsoft.graph.customFieldValue",
  "id": "32618015-76cd-34e6-561e-21ced3b2077b",
  "customFieldDefinitionId": "String",
  "value": "String"
}