Skip to main content
Planview Customer Success Center

Application API (v1): Assign User to a Task Card

This method assigns a single user to a Task Card. If a one or more users are already assigned to the Card, this method will add the given user to the list of assigned users. UserId is required in the POST body. This value can be found using Get Board Identifiers. OverrideComment is not required, but may be necessary if assigning the user would exceed the user's personal WIP limit.

Request URL (POST):

https://{accountname}.leankit.com/kanban/api/v1/board/{boardId}/assign/card/{cardId}/tasks/{taskCardId}

Sample Request:

https://myaccount.leankit.com/kanban/api/v1/board/256064019/assign/card/256501042/tasks/256501044
{
    "UserId": 62984826,
    "OverrideComment": "Because reasons..."
}

Sample Response:

{
  "ReplyData": [
    {
      "BoardVersion": 7,
      "CardDTO": {
        "SystemType": "Card",
        "BoardId": 256064019,
        "BoardTitle": "Sample Board",
        "LaneId": 256485507,
        "LaneTitle": "ToDo",
        "Title": "Task 1 - Updated",
        "Description": "New description of task",
        "Type": {
          "Id": 256291537
        },
        "TypeId": 256291537,
        "Priority": 1,
        "PriorityText": "Normal",
        "TypeName": "Subtask",
        "TypeIconPath": null,
        "TypeColorHex": "#F8F7D2",
        "Size": 0,
        "Active": false,
        "Color": "#F8F7D2",
        "Icon": "",
        "Version": 6,
        "AssignedUsers": [
          {
            "Id": 62984826,
            "GravatarLink": "3ab1249be442027903e1180025340b3f?s=25",
            "SmallGravatarLink": "3ab1249be442027903e1180025340b3f?s=17",
            "EmailAddress": "david@test.com",
            "FullName": "David Neal",
            "AssignedUserName": "David Neal",
            "AssignedUserId": 62984826
          }
        ],
        "IsBlocked": false,
        "BlockReason": null,
        "BlockStateChangeDate": null,
        "Index": 1,
        "StartDate": null,
        "DueDate": null,
        "ExternalSystemName": null,
        "ExternalSystemUrl": null,
        "ExternalCardID": null,
        "ExternalCardIdPrefix": null,
        "Tags": null,
        "ParentBoardId": 0,
        "ParentTaskboardId": 256422779,
        "CountOfOldCards": 0,
        "CardContexts": [],
        "LastMove": "10/14/2015 04:52:11 PM",
        "LastActivity": "10/15/2015 08:01:49 AM",
        "DateArchived": null,
        "CommentsCount": 0,
        "LastComment": null,
        "AttachmentsCount": 0,
        "LastAttachment": null,
        "CreateDate": "10/14/2015",
        "ActualStartDate": "10/14/2015 8:51:51 PM",
        "ActualFinishDate": null,
        "AssignedUserName": "David Neal",
        "AssignedUserId": 62984826,
        "AssignedUserIds": [
          62984826
        ],
        "GravatarLink": "3ab1249be442027903e1180025340b3f?s=25",
        "SmallGravatarLink": "3ab1249be442027903e1180025340b3f?s=17",
        "IsOlderThanXDays": false,
        "Id": 256501044,
        "DrillThroughBoardId": null,
        "HasDrillThroughBoard": false,
        "DrillThroughStatistics": null,
        "DrillThroughCompletionPercent": null,
        "DrillThroughProgressTotal": null,
        "DrillThroughProgressComplete": null,
        "DrillThroughProgressSizeComplete": null,
        "DrillThroughProgressSizeTotal": null,
        "ClassOfServiceId": 0,
        "ClassOfServiceTitle": null,
        "ClassOfServiceIconPath": null,
        "ClassOfServiceColorHex": null,
        "ClassOfServiceCustomIconName": null,
        "ClassOfServiceCustomIconColor": null,
        "CardTypeIconColor": null,
        "CardTypeIconName": null,
        "CurrentTaskBoardId": null,
        "TaskBoardCompletionPercent": 0,
        "TaskBoardCompletedCardCount": 0,
        "TaskBoardCompletedCardSize": 0,
        "TaskBoardTotalCards": 0,
        "TaskBoardTotalSize": 0,
        "CurrentContext": null,
        "ParentCardId": null
      },
      "CardSubscription": null
    }
  ],
  "ReplyCode": 202,
  "ReplyText": "The User was successfully assigned."
}