Skip to main content
PATCH
/
v1
/
actions
/
{actionId}
/
assignee
/
status
Update assigned action status
curl --request PATCH \
  --url https://staging.api.us.aptlydone.com/actions/v1/actions/{actionId}/assignee/status \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "status": "To Do",
  "documentId": "30af6294-e42a-4c31-9a6f-88b1bdba06e1",
  "roleId": "6bbe147a-8da6-490d-b574-e6b05a66e584",
  "delegationId": "0f065dce-c2dc-411e-86db-e3d2ad044f13",
  "decisionId": "bb76a516-bee0-47ef-b8f0-ca9245ede3a6"
}'
{
  "statusCode": 200,
  "timestamp": "2025-06-24T08:49:16.735Z",
  "message": "Success",
  "data": {
    "id": "9c01cfd5-3e64-4001-a8c5-0abb3fcdf62b",
    "actionId": "10001",
    "tenantId": "affb22b1-82ae-4226-8fac-bdb410f052c3",
    "actionName": "Review Financial Report",
    "description": "This action requires reviewing the Q1 financial report.",
    "actionTypeId": "e50b387b-856e-4d15-9c3b-ff2210afc42e",
    "actionType": {
      "id": "2b78310f-86fc-4b49-bec5-636960fb242a",
      "tenantId": "81e70d36-416d-42fd-9e36-1ffaafb5d737",
      "type": "Meeting",
      "typeIcon": "calendar",
      "status": true,
      "isCustom": false
    },
    "actionTemplateId": "97c8957d-6357-47c3-8caf-22409060e25e",
    "actionTemplate": {
      "id": "bad70123-b043-42d9-a80a-4d95099879e8",
      "tenantId": "f1dfaa64-a420-4b8b-b105-7cce3e530ce7",
      "name": "Weekly Status Meeting",
      "description": "Template for recurring team status meetings",
      "status": true,
      "type": {
        "id": "2b78310f-86fc-4b49-bec5-636960fb242a",
        "tenantId": "81e70d36-416d-42fd-9e36-1ffaafb5d737",
        "type": "Meeting",
        "typeIcon": "calendar",
        "status": true,
        "isCustom": false
      }
    },
    "actionPriorityId": "e206b561-7c41-4dba-9ddc-81c2b0e0a255",
    "actionStatusId": "3e35cc7c-44f2-49f0-8b97-40e5799be28d",
    "decisionId": "8af836e5-fe8e-4a78-a79c-5a30df373774",
    "decisionDisplayId": "10001",
    "delegationId": "907cb4b9-73a5-4d5a-bb26-492397a3c723",
    "delegationDisplayId": "10001",
    "documentId": "8b506f3d-da53-4c1c-9eb8-61dc4ef4185b",
    "documentDisplayId": "10001",
    "roleId": "8bc8cfce-7186-48b3-9403-cd35c10f4fcd",
    "link": "eyJ0ZW5hbnRJZCI6mZTktMmU5Zi00NDkxLTk5MTctYmFlYWUwY2UwYTQ2In0=",
    "ownerId": "232ada91-905f-4370-95b0-92b5060a03b9",
    "owner": {
      "id": "db1e5b12-5d8f-4856-aa2f-8e96bc41d655",
      "email": "[email protected]",
      "name": "Lorene Hilll",
      "firstName": "Esta",
      "lastName": "Bednar",
      "profileImageUrl": "https://picsum.photos/seed/uSdruM/1774/3925",
      "positions": [
        {
          "id": "c98d0654-88af-4357-92d9-619b13c0fa17",
          "positionName": "Managing Director - North",
          "autoProvisioned": false
        }
      ],
      "mobilePhone": "987654321"
    },
    "dueDate": "2025-04-15T14:00:00.000Z",
    "createdAt": "2025-03-01T09:00:00.000Z",
    "updateAt": "2025-03-01T09:00:00.000Z",
    "createdBy": "name of creator",
    "updateBy": "name of updator",
    "deletedOn": "2025-03-01T09:00:00.000Z",
    "deletedBy": "name of deletor",
    "copiedFrom": "bd4ca965-c78a-48d7-ab3c-54221b33e78a",
    "isDeleted": false,
    "isSystemGenerated": false,
    "assignees": [
      {
        "id": "96ab6544-06f4-431c-9791-e69171a77622",
        "assigneeId": "a3a5b11f-596b-4246-b15f-342ea6069f2a",
        "assignee": {
          "id": "db1e5b12-5d8f-4856-aa2f-8e96bc41d655",
          "email": "[email protected]",
          "name": "Lorene Hilll",
          "firstName": "Esta",
          "lastName": "Bednar",
          "profileImageUrl": "https://picsum.photos/seed/uSdruM/1774/3925",
          "positions": [
            {
              "id": "c98d0654-88af-4357-92d9-619b13c0fa17",
              "positionName": "Managing Director - North",
              "autoProvisioned": false
            }
          ],
          "mobilePhone": "987654321"
        },
        "actionStatusId": "38ae697f-9f5a-45ba-9f34-bb625eb9e2fe",
        "actionStatusName": "TO DO",
        "actionTakenDate": "2025-03-10T09:00:00.000Z"
      }
    ],
    "files": [
      {
        "id": "0eb35285-ed5f-4401-b939-cc52295001bb",
        "fileUrl": "https://storage.example.com/files/report.pdf",
        "fileType": "pdf",
        "fileName": "fileName",
        "createdAt": "2025-03-05T14:30:00.000Z"
      }
    ],
    "priority": {
      "id": "f5d112a4-cb8d-4a77-bbeb-cbb0c0c4d83a",
      "actionPriorityName": "High",
      "isEnabled": true,
      "colorName": "green"
    },
    "status": {
      "id": "af137014-275e-4918-a937-0144950bc38f",
      "actionStatusName": "In Progress",
      "isEnabled": true
    },
    "permissions": [
      {
        "allowed": true,
        "relationship_key": "<string>"
      }
    ]
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
actionId
string
required

Body

application/json
​
status
enum<string>
required

Status Name for the action

Available options:
To Do,
Denied,
Approved,
Accepted,
Reviewed,
Rejected,
In Progress,
Completed,
Cancelled,
Assigned,
Deleted,
Overdue,
Pending,
Acknowledged
​
documentId
string<uuid>

Document ID (optional)

Example:

"30af6294-e42a-4c31-9a6f-88b1bdba06e1"

​
roleId
string<uuid>

Decision role ID (optional)

Example:

"6bbe147a-8da6-490d-b574-e6b05a66e584"

​
delegationId
string<uuid>

Delegation ID (optional)

Example:

"0f065dce-c2dc-411e-86db-e3d2ad044f13"

​
decisionId
string<uuid>

Decision ID (optional)

Example:

"bb76a516-bee0-47ef-b8f0-ca9245ede3a6"

Response

200 - application/json

Action status updated successfully

​
statusCode
number
required

HTTP Status code

Example:

200

​
timestamp
string
required

Timestamp of the response

Example:

"2025-06-24T08:49:16.735Z"

​
message
string
required

Response message

Example:

"Success"

​
data
object
required

Response data