Skip to main content
PUT
/
api
/
tasks
/
{id}
/
assignee
cURL
curl --request PUT \
  --url http://localhost/api/tasks/{id}/assignee \
  --header 'Content-Type: application/json' \
  --data '{
  "uuid": "<string>",
  "createdOn": "2023-11-07T05:31:56Z",
  "updatedOn": "2023-11-07T05:31:56Z",
  "changeSequence": 123,
  "email": "<string>",
  "firstName": "<string>",
  "lastName": "<string>",
  "bio": "<string>",
  "userStorage": {
    "favoriteLinks": [
      {
        "link": "<string>"
      }
    ]
  },
  "showDeveloperTools": true,
  "userHash": "<string>",
  "acceptedTerms": true,
  "userType": "HUMAN",
  "active": true,
  "externallyManaged": true,
  "hasAcceptedTerms": true,
  "id": "<string>",
  "security": {
    "roles": [
      "PLATFORM_ADMIN"
    ]
  },
  "preferences": {
    "showWelcomeMessage": true,
    "showOnboarding": true,
    "showScrollbars": true
  }
}'
{
  "uuid": "<string>",
  "createdOn": "2023-11-07T05:31:56Z",
  "updatedOn": "2023-11-07T05:31:56Z",
  "changeSequence": 123,
  "project": {
    "uuid": "<string>",
    "createdOn": "2023-11-07T05:31:56Z",
    "updatedOn": "2023-11-07T05:31:56Z",
    "changeSequence": 123,
    "organization": {
      "uuid": "<string>",
      "createdOn": "2023-11-07T05:31:56Z",
      "updatedOn": "2023-11-07T05:31:56Z",
      "changeSequence": 123,
      "name": "<string>",
      "slug": "<string>",
      "publicAccess": true,
      "description": "<string>",
      "organizationStatus": "ACTIVE",
      "hasImage": true,
      "defaultToPrivateTemplates": true,
      "supportAccess": true,
      "supportAccessExpiresAt": "2023-11-07T05:31:56Z",
      "stripeCustomerId": "<string>",
      "enterpriseOrganization": true,
      "id": "<string>"
    },
    "name": "<string>",
    "description": "<string>",
    "owner": {
      "uuid": "<string>",
      "createdOn": "2023-11-07T05:31:56Z",
      "updatedOn": "2023-11-07T05:31:56Z",
      "changeSequence": 123,
      "email": "<string>",
      "firstName": "<string>",
      "lastName": "<string>",
      "bio": "<string>",
      "userStorage": {
        "favoriteLinks": [
          {}
        ]
      },
      "showDeveloperTools": true,
      "image": "<string>",
      "userHash": "<string>",
      "acceptedTerms": true,
      "userType": "HUMAN",
      "active": true,
      "fullName": "<string>",
      "externallyManaged": true,
      "hasAcceptedTerms": true,
      "id": "<string>",
      "security": {
        "roles": [
          "PLATFORM_ADMIN"
        ]
      },
      "preferences": {
        "showWelcomeMessage": true,
        "showOnboarding": true,
        "showScrollbars": true
      }
    },
    "status": {
      "uuid": "<string>",
      "createdOn": "2023-11-07T05:31:56Z",
      "updatedOn": "2023-11-07T05:31:56Z",
      "changeSequence": 123,
      "organization": {
        "uuid": "<string>",
        "createdOn": "2023-11-07T05:31:56Z",
        "updatedOn": "2023-11-07T05:31:56Z",
        "changeSequence": 123,
        "name": "<string>",
        "slug": "<string>",
        "publicAccess": true,
        "description": "<string>",
        "organizationStatus": "ACTIVE",
        "hasImage": true,
        "defaultToPrivateTemplates": true,
        "supportAccess": true,
        "supportAccessExpiresAt": "2023-11-07T05:31:56Z",
        "stripeCustomerId": "<string>",
        "enterpriseOrganization": true,
        "id": "<string>"
      },
      "color": "<string>",
      "icon": "<string>",
      "status": "<string>",
      "production": true,
      "id": "<string>"
    },
    "templateArticleId": "<string>",
    "projectTemplateRef": "<string>",
    "notes": "<string>",
    "color": "<string>",
    "tags": [
      {
        "uuid": "<string>",
        "createdOn": "2023-11-07T05:31:56Z",
        "updatedOn": "2023-11-07T05:31:56Z",
        "changeSequence": 123,
        "organization": {
          "uuid": "<string>",
          "createdOn": "2023-11-07T05:31:56Z",
          "updatedOn": "2023-11-07T05:31:56Z",
          "changeSequence": 123,
          "name": "<string>",
          "slug": "<string>",
          "publicAccess": true,
          "description": "<string>",
          "organizationStatus": "ACTIVE",
          "hasImage": true,
          "defaultToPrivateTemplates": true,
          "supportAccess": true,
          "supportAccessExpiresAt": "2023-11-07T05:31:56Z",
          "stripeCustomerId": "<string>",
          "enterpriseOrganization": true,
          "id": "<string>"
        },
        "name": "<string>",
        "color": "<string>",
        "id": "<string>"
      }
    ],
    "dataFlow": {
      "viewPort": {
        "x": 123,
        "y": 123,
        "zoom": 123
      },
      "nodes": [
        {
          "id": "<string>",
          "parentId": "<string>",
          "type": "<string>",
          "position": {},
          "dimensions": {},
          "properties": {}
        }
      ],
      "edges": [
        {
          "id": "<string>",
          "source": "<string>",
          "target": "<string>",
          "properties": {}
        }
      ]
    },
    "options": {
      "options": [
        {
          "groupOptions": [
            "<any>"
          ],
          "properties": {},
          "tabName": "<string>",
          "name": "<string>",
          "aliases": [
            "<any>"
          ],
          "label": "<string>",
          "falseLabel": "<string>",
          "hint": "<string>",
          "required": true,
          "type": "<string>",
          "subType": "<string>",
          "listType": "<string>",
          "displayProperties": {},
          "listLabel": "<string>",
          "listDescription": "<string>",
          "featureFlag": "<string>",
          "default": {},
          "description": "<string>",
          "supportArticle": "<string>",
          "overviewMarkdown": "<string>",
          "showIf": "<string>",
          "developerOnly": true,
          "showOnPopup": true,
          "possibleValues": [
            "<any>"
          ]
        }
      ],
      "properties": {},
      "groupTaxonTypeFeatures": {},
      "taxonTypeFeatures": {},
      "taskOptions": {
        "showTakeNext": true,
        "showNewTask": true
      }
    },
    "documentStatuses": [
      {
        "uuid": "<string>",
        "createdOn": "2023-11-07T05:31:56Z",
        "updatedOn": "2023-11-07T05:31:56Z",
        "changeSequence": 123,
        "color": "<string>",
        "icon": "<string>",
        "status": "<string>",
        "slug": "<string>",
        "statusType": "UNRESOLVED",
        "id": "<string>"
      }
    ],
    "statusType": "ACTIVE",
    "taskStatuses": [
      {
        "uuid": "<string>",
        "createdOn": "2023-11-07T05:31:56Z",
        "updatedOn": "2023-11-07T05:31:56Z",
        "changeSequence": 123,
        "color": "<string>",
        "icon": "<string>",
        "label": "<string>",
        "slug": "<string>",
        "statusType": "TODO",
        "id": "<string>"
      }
    ],
    "id": "<string>"
  },
  "title": "<string>",
  "description": "<string>",
  "metadata": {
    "properties": {}
  },
  "template": {
    "uuid": "<string>",
    "createdOn": "2023-11-07T05:31:56Z",
    "updatedOn": "2023-11-07T05:31:56Z",
    "changeSequence": 123,
    "project": {
      "uuid": "<string>",
      "createdOn": "2023-11-07T05:31:56Z",
      "updatedOn": "2023-11-07T05:31:56Z",
      "changeSequence": 123,
      "organization": {
        "uuid": "<string>",
        "createdOn": "2023-11-07T05:31:56Z",
        "updatedOn": "2023-11-07T05:31:56Z",
        "changeSequence": 123,
        "name": "<string>",
        "slug": "<string>",
        "publicAccess": true,
        "description": "<string>",
        "organizationStatus": "ACTIVE",
        "hasImage": true,
        "defaultToPrivateTemplates": true,
        "supportAccess": true,
        "supportAccessExpiresAt": "2023-11-07T05:31:56Z",
        "stripeCustomerId": "<string>",
        "enterpriseOrganization": true,
        "id": "<string>"
      },
      "name": "<string>",
      "description": "<string>",
      "owner": {
        "uuid": "<string>",
        "createdOn": "2023-11-07T05:31:56Z",
        "updatedOn": "2023-11-07T05:31:56Z",
        "changeSequence": 123,
        "email": "<string>",
        "firstName": "<string>",
        "lastName": "<string>",
        "bio": "<string>",
        "userStorage": {
          "favoriteLinks": [
            {}
          ]
        },
        "showDeveloperTools": true,
        "image": "<string>",
        "userHash": "<string>",
        "acceptedTerms": true,
        "userType": "HUMAN",
        "active": true,
        "fullName": "<string>",
        "externallyManaged": true,
        "hasAcceptedTerms": true,
        "id": "<string>",
        "security": {
          "roles": [
            "PLATFORM_ADMIN"
          ]
        },
        "preferences": {
          "showWelcomeMessage": true,
          "showOnboarding": true,
          "showScrollbars": true
        }
      },
      "status": {
        "uuid": "<string>",
        "createdOn": "2023-11-07T05:31:56Z",
        "updatedOn": "2023-11-07T05:31:56Z",
        "changeSequence": 123,
        "organization": {
          "uuid": "<string>",
          "createdOn": "2023-11-07T05:31:56Z",
          "updatedOn": "2023-11-07T05:31:56Z",
          "changeSequence": 123,
          "name": "<string>",
          "slug": "<string>",
          "publicAccess": true,
          "description": "<string>",
          "organizationStatus": "ACTIVE",
          "hasImage": true,
          "defaultToPrivateTemplates": true,
          "supportAccess": true,
          "supportAccessExpiresAt": "2023-11-07T05:31:56Z",
          "stripeCustomerId": "<string>",
          "enterpriseOrganization": true,
          "id": "<string>"
        },
        "color": "<string>",
        "icon": "<string>",
        "status": "<string>",
        "production": true,
        "id": "<string>"
      },
      "templateArticleId": "<string>",
      "projectTemplateRef": "<string>",
      "notes": "<string>",
      "color": "<string>",
      "tags": [
        {
          "uuid": "<string>",
          "createdOn": "2023-11-07T05:31:56Z",
          "updatedOn": "2023-11-07T05:31:56Z",
          "changeSequence": 123,
          "organization": {
            "uuid": "<string>",
            "createdOn": "2023-11-07T05:31:56Z",
            "updatedOn": "2023-11-07T05:31:56Z",
            "changeSequence": 123,
            "name": "<string>",
            "slug": "<string>",
            "publicAccess": true,
            "description": "<string>",
            "organizationStatus": "ACTIVE",
            "hasImage": true,
            "defaultToPrivateTemplates": true,
            "supportAccess": true,
            "supportAccessExpiresAt": "2023-11-07T05:31:56Z",
            "stripeCustomerId": "<string>",
            "enterpriseOrganization": true,
            "id": "<string>"
          },
          "name": "<string>",
          "color": "<string>",
          "id": "<string>"
        }
      ],
      "dataFlow": {
        "viewPort": {
          "x": 123,
          "y": 123,
          "zoom": 123
        },
        "nodes": [
          {
            "id": "<string>",
            "parentId": "<string>",
            "type": "<string>",
            "position": {},
            "dimensions": {},
            "properties": {}
          }
        ],
        "edges": [
          {
            "id": "<string>",
            "source": "<string>",
            "target": "<string>",
            "properties": {}
          }
        ]
      },
      "options": {
        "options": [
          {
            "groupOptions": [
              "<any>"
            ],
            "properties": {},
            "tabName": "<string>",
            "name": "<string>",
            "aliases": [
              "<any>"
            ],
            "label": "<string>",
            "falseLabel": "<string>",
            "hint": "<string>",
            "required": true,
            "type": "<string>",
            "subType": "<string>",
            "listType": "<string>",
            "displayProperties": {},
            "listLabel": "<string>",
            "listDescription": "<string>",
            "featureFlag": "<string>",
            "default": {},
            "description": "<string>",
            "supportArticle": "<string>",
            "overviewMarkdown": "<string>",
            "showIf": "<string>",
            "developerOnly": true,
            "showOnPopup": true,
            "possibleValues": [
              "<any>"
            ]
          }
        ],
        "properties": {},
        "groupTaxonTypeFeatures": {},
        "taxonTypeFeatures": {},
        "taskOptions": {
          "showTakeNext": true,
          "showNewTask": true
        }
      },
      "documentStatuses": [
        {
          "uuid": "<string>",
          "createdOn": "2023-11-07T05:31:56Z",
          "updatedOn": "2023-11-07T05:31:56Z",
          "changeSequence": 123,
          "color": "<string>",
          "icon": "<string>",
          "status": "<string>",
          "slug": "<string>",
          "statusType": "UNRESOLVED",
          "id": "<string>"
        }
      ],
      "statusType": "ACTIVE",
      "taskStatuses": [
        {
          "uuid": "<string>",
          "createdOn": "2023-11-07T05:31:56Z",
          "updatedOn": "2023-11-07T05:31:56Z",
          "changeSequence": 123,
          "color": "<string>",
          "icon": "<string>",
          "label": "<string>",
          "slug": "<string>",
          "statusType": "TODO",
          "id": "<string>"
        }
      ],
      "id": "<string>"
    },
    "name": "<string>",
    "description": "<string>",
    "slug": "<string>",
    "metadata": {
      "options": [
        {
          "groupOptions": [
            "<any>"
          ],
          "properties": {},
          "tabName": "<string>",
          "name": "<string>",
          "aliases": [
            "<any>"
          ],
          "label": "<string>",
          "falseLabel": "<string>",
          "hint": "<string>",
          "required": true,
          "type": "<string>",
          "subType": "<string>",
          "listType": "<string>",
          "displayProperties": {},
          "listLabel": "<string>",
          "listDescription": "<string>",
          "featureFlag": "<string>",
          "default": {},
          "description": "<string>",
          "supportArticle": "<string>",
          "overviewMarkdown": "<string>",
          "showIf": "<string>",
          "developerOnly": true,
          "showOnPopup": true,
          "possibleValues": [
            "<any>"
          ]
        }
      ],
      "forms": [
        {
          "dataFormRef": "<string>",
          "actions": [
            {
              "uuid": "<string>",
              "type": "<string>",
              "label": "<string>",
              "properties": {}
            }
          ],
          "availablePanels": {},
          "properties": {}
        }
      ],
      "actions": [
        {
          "uuid": "<string>",
          "type": "<string>",
          "label": "<string>",
          "properties": {}
        }
      ],
      "documentFamilyGroups": [
        {
          "name": "<string>",
          "notes": "<string>",
          "documentFamilyFilter": "<string>",
          "maxHits": 123,
          "sort": "<string>",
          "automaticallyAdd": true,
          "editable": true
        }
      ],
      "workspaceId": "<string>",
      "properties": {},
      "priority": 123
    },
    "id": "<string>"
  },
  "dueDate": "2023-12-25",
  "completedDate": "2023-12-25",
  "status": {
    "uuid": "<string>",
    "createdOn": "2023-11-07T05:31:56Z",
    "updatedOn": "2023-11-07T05:31:56Z",
    "changeSequence": 123,
    "color": "<string>",
    "icon": "<string>",
    "label": "<string>",
    "slug": "<string>",
    "statusType": "TODO",
    "id": "<string>"
  },
  "assignee": {
    "uuid": "<string>",
    "createdOn": "2023-11-07T05:31:56Z",
    "updatedOn": "2023-11-07T05:31:56Z",
    "changeSequence": 123,
    "email": "<string>",
    "firstName": "<string>",
    "lastName": "<string>",
    "bio": "<string>",
    "userStorage": {
      "favoriteLinks": [
        {}
      ]
    },
    "showDeveloperTools": true,
    "image": "<string>",
    "userHash": "<string>",
    "acceptedTerms": true,
    "userType": "HUMAN",
    "active": true,
    "fullName": "<string>",
    "externallyManaged": true,
    "hasAcceptedTerms": true,
    "id": "<string>",
    "security": {
      "roles": [
        "PLATFORM_ADMIN"
      ]
    },
    "preferences": {
      "showWelcomeMessage": true,
      "showOnboarding": true,
      "showScrollbars": true
    }
  },
  "tags": [
    {
      "uuid": "<string>",
      "createdOn": "2023-11-07T05:31:56Z",
      "updatedOn": "2023-11-07T05:31:56Z",
      "changeSequence": 123,
      "project": {
        "uuid": "<string>",
        "createdOn": "2023-11-07T05:31:56Z",
        "updatedOn": "2023-11-07T05:31:56Z",
        "changeSequence": 123,
        "organization": {
          "uuid": "<string>",
          "createdOn": "2023-11-07T05:31:56Z",
          "updatedOn": "2023-11-07T05:31:56Z",
          "changeSequence": 123,
          "name": "<string>",
          "slug": "<string>",
          "publicAccess": true,
          "description": "<string>",
          "organizationStatus": "ACTIVE",
          "hasImage": true,
          "defaultToPrivateTemplates": true,
          "supportAccess": true,
          "supportAccessExpiresAt": "2023-11-07T05:31:56Z",
          "stripeCustomerId": "<string>",
          "enterpriseOrganization": true,
          "id": "<string>"
        },
        "name": "<string>",
        "description": "<string>",
        "owner": {
          "uuid": "<string>",
          "createdOn": "2023-11-07T05:31:56Z",
          "updatedOn": "2023-11-07T05:31:56Z",
          "changeSequence": 123,
          "email": "<string>",
          "firstName": "<string>",
          "lastName": "<string>",
          "bio": "<string>",
          "userStorage": {
            "favoriteLinks": [
              {}
            ]
          },
          "showDeveloperTools": true,
          "image": "<string>",
          "userHash": "<string>",
          "acceptedTerms": true,
          "userType": "HUMAN",
          "active": true,
          "fullName": "<string>",
          "externallyManaged": true,
          "hasAcceptedTerms": true,
          "id": "<string>",
          "security": {
            "roles": [
              "PLATFORM_ADMIN"
            ]
          },
          "preferences": {
            "showWelcomeMessage": true,
            "showOnboarding": true,
            "showScrollbars": true
          }
        },
        "status": {
          "uuid": "<string>",
          "createdOn": "2023-11-07T05:31:56Z",
          "updatedOn": "2023-11-07T05:31:56Z",
          "changeSequence": 123,
          "organization": {
            "uuid": "<string>",
            "createdOn": "2023-11-07T05:31:56Z",
            "updatedOn": "2023-11-07T05:31:56Z",
            "changeSequence": 123,
            "name": "<string>",
            "slug": "<string>",
            "publicAccess": true,
            "description": "<string>",
            "organizationStatus": "ACTIVE",
            "hasImage": true,
            "defaultToPrivateTemplates": true,
            "supportAccess": true,
            "supportAccessExpiresAt": "2023-11-07T05:31:56Z",
            "stripeCustomerId": "<string>",
            "enterpriseOrganization": true,
            "id": "<string>"
          },
          "color": "<string>",
          "icon": "<string>",
          "status": "<string>",
          "production": true,
          "id": "<string>"
        },
        "templateArticleId": "<string>",
        "projectTemplateRef": "<string>",
        "notes": "<string>",
        "color": "<string>",
        "tags": [
          {
            "uuid": "<string>",
            "createdOn": "2023-11-07T05:31:56Z",
            "updatedOn": "2023-11-07T05:31:56Z",
            "changeSequence": 123,
            "organization": {
              "uuid": "<string>",
              "createdOn": "2023-11-07T05:31:56Z",
              "updatedOn": "2023-11-07T05:31:56Z",
              "changeSequence": 123,
              "name": "<string>",
              "slug": "<string>",
              "publicAccess": true,
              "description": "<string>",
              "organizationStatus": "ACTIVE",
              "hasImage": true,
              "defaultToPrivateTemplates": true,
              "supportAccess": true,
              "supportAccessExpiresAt": "2023-11-07T05:31:56Z",
              "stripeCustomerId": "<string>",
              "enterpriseOrganization": true,
              "id": "<string>"
            },
            "name": "<string>",
            "color": "<string>",
            "id": "<string>"
          }
        ],
        "dataFlow": {
          "viewPort": {
            "x": 123,
            "y": 123,
            "zoom": 123
          },
          "nodes": [
            {
              "id": "<string>",
              "parentId": "<string>",
              "type": "<string>",
              "position": {},
              "dimensions": {},
              "properties": {}
            }
          ],
          "edges": [
            {
              "id": "<string>",
              "source": "<string>",
              "target": "<string>",
              "properties": {}
            }
          ]
        },
        "options": {
          "options": [
            {
              "groupOptions": [
                "<any>"
              ],
              "properties": {},
              "tabName": "<string>",
              "name": "<string>",
              "aliases": [
                "<any>"
              ],
              "label": "<string>",
              "falseLabel": "<string>",
              "hint": "<string>",
              "required": true,
              "type": "<string>",
              "subType": "<string>",
              "listType": "<string>",
              "displayProperties": {},
              "listLabel": "<string>",
              "listDescription": "<string>",
              "featureFlag": "<string>",
              "default": {},
              "description": "<string>",
              "supportArticle": "<string>",
              "overviewMarkdown": "<string>",
              "showIf": "<string>",
              "developerOnly": true,
              "showOnPopup": true,
              "possibleValues": [
                "<any>"
              ]
            }
          ],
          "properties": {},
          "groupTaxonTypeFeatures": {},
          "taxonTypeFeatures": {},
          "taskOptions": {
            "showTakeNext": true,
            "showNewTask": true
          }
        },
        "documentStatuses": [
          {
            "uuid": "<string>",
            "createdOn": "2023-11-07T05:31:56Z",
            "updatedOn": "2023-11-07T05:31:56Z",
            "changeSequence": 123,
            "color": "<string>",
            "icon": "<string>",
            "status": "<string>",
            "slug": "<string>",
            "statusType": "UNRESOLVED",
            "id": "<string>"
          }
        ],
        "statusType": "ACTIVE",
        "taskStatuses": [
          {
            "uuid": "<string>",
            "createdOn": "2023-11-07T05:31:56Z",
            "updatedOn": "2023-11-07T05:31:56Z",
            "changeSequence": 123,
            "color": "<string>",
            "icon": "<string>",
            "label": "<string>",
            "slug": "<string>",
            "statusType": "TODO",
            "id": "<string>"
          }
        ],
        "id": "<string>"
      },
      "name": "<string>",
      "color": "<string>",
      "id": "<string>"
    }
  ],
  "priority": 123,
  "id": "<string>"
}

Path Parameters

​
id
string
required

Body

application/json

A user of the Kodexa Platform

​
email
string
required

Email address of the user

​
uuid
string

The UUID of the object

​
createdOn
string<date-time>
​
updatedOn
string<date-time>
​
changeSequence
integer

The change sequence of the object, which can be used to track modications

​
firstName
string

First name of the user

​
lastName
string

Last name of the user

​
bio
string

About the user

​
userStorage
object

Metadata storage for the user

​
showDeveloperTools
boolean

Show developer tools in the UI

​
userHash
string
​
acceptedTerms
boolean
​
userType
enum<string>
Available options:
HUMAN,
ASSISTANT,
SERVICE
​
active
boolean

Flag to indicate if the user is active

​
externallyManaged
boolean
​
hasAcceptedTerms
boolean

Flag to indicate if the user has accepted the terms of service

​
id
string

The ID of the object

​
security
object
​
preferences
object

Response

OK

​
project
object
required
​
uuid
string

The UUID of the object

​
createdOn
string<date-time>
​
updatedOn
string<date-time>
​
changeSequence
integer

The change sequence of the object, which can be used to track modications

​
title
string
​
description
string
​
metadata
object
​
template
object
​
dueDate
string<date>
​
completedDate
string<date>
​
status
object
​
assignee
object

A user of the Kodexa Platform

​
tags
object[]
​
priority
integer
​
id
string

The ID of the object

⌘I