Loading ...

REST API: Update Task | Axero Documentation

Home » axero documentation » Wiki » Documentation » REST API Overview » REST API: Content » REST API: Tasks » REST API: Update Task
Axero Documentation  Wiki
Public Space
Activity Stream Content
Version 26

REST API: Update Task

0 
 /5
0 (0votes)
Open API Guide
PUT/api/tasks/{TaskID}

Update an existing task. Only the fields you send change; the others keep their values. ResponseData is the updated task and ResponseMessage the site's task-updated text.

Request

Request Header

HeaderRequiredValueDescription
AuthorizationYESBearer YOUR_TOKENBearer token for the authenticated user. Learn how to create Bearer tokens.
Content-TypeYESapplication/jsonMust be set to application/json

Required Parameters

ParameterTypeRequiredLocationDescription
TaskIDIntegerYESPathUnique ID of the task
Task JSONStringYESBodyA JSON object (a set of named fields and their values) with the fields to change. Field names must match the capitalization shown on this page: a field sent as taskname is ignored. A body that is not a JSON object changes nothing and still answers 200.

Optional Parameters

ParameterTypeRequiredLocationDescription
TaskNameStringNOBodyDisplay name for the task. Appears in task lists and notifications.
TaskListIDIntegerNOBodyID of the task list to move the task to. Send a real task list ID. A value that is not a number, an empty string, or null takes the task out of its list. The task can then no longer be read, updated, or deleted.
SpaceIDIntegerNOBodyNot saved: the task keeps its space. The value is only used to check whether the caller may reassign the task.
TaskDescriptionStringNOBodyDetailed description of the task. HTML is accepted, and unsafe markup is removed.
AssignedToUserIDIntegerNOBodyID of the user to assign the task to. The new assignee gets an email about the task. A value that is not a number unassigns the task.
TaskStatusIDIntegerNOBodyID of the task status to set. A value that is not a number clears the status.
TaskPriorityIDIntegerNOBodyID of the task priority to set. A value that is not a number clears the priority.
TaskDueDateStringNOBodyDue date for the task in ISO 8601 format (e.g., 2026-03-15T00:00:00Z). A value that cannot be read as a date, or null, removes the due date.
TaskEstimatedHoursIntegerNOBodyThe task's estimated completion time in hours, saved as a whole number: 3.5 is saved as 4. A value that is not a number clears it.
FollowerUserNamesCsvStringNOBodyA comma-separated list of usernames or user IDs of the people who should follow the task. The list replaces the current followers, and each new follower other than the caller is notified. Leave it out to keep the current followers.

Example

Request Header

Authorization: Bearer YOUR_TOKEN
Content-Type: application/json

Request URL

https://your-site.com/api/tasks/734

Request Body

{
  "TaskName": "Prepare Q4 Financial Report",
  "TaskListID": 704,
  "SpaceID": 418,
  "TaskDescription": "Compile and check the financial data for the Q4 report.",
  "AssignedToUserID": 573,
  "TaskStatusID": 3729,
  "TaskPriorityID": 2470,
  "TaskDueDate": "12/20/2024",
  "TaskEstimatedHours": 5,
  "FollowerUserNamesCsv": "robert,alice"
}

Success Response

{
  "IsError": false,
  "ResponseMessage": "Task has been updated.",
  "ResponseData": {
    "TaskID": 796,
    "TaskName": "Prepare Q4 Financial Report",
    "TaskDescription": "Compile and check the financial data for the Q4 report.",
    "IssueDescriptionUnprocessed": "Compile and check the financial data for the Q4 report.",
    "TaskSortOrder": 1,
    "TaskListID": 840,
    "IsCompleted": false,
    "SpaceID": 313,
    "AssignedToUserID": 804,
    "TaskDueDate": "2026-12-20T00:00:00",
    "DateStringTaskEnd": "12/19/2026",
    "PastDue": false,
    "AssignedToUserDisplayName": "John Smith",
    "TaskListName": "Employee Onboarding",
    "TaskStatusTypeID": 0,
    "TaskStatusID": 2671,
    "TaskPriorityID": 1840,
    "DateCreated": "2026-09-26T13:51:52.247",
    "ReportedByUserID": 630,
    "DateUpdated": "2026-09-26T13:51:53.3244138Z",
    "FollowerUserNamesCsv": "804",
    "ReferencedEntityID": 0,
    "ReferencedEntityType": 0,
    "TaskEstimatedHours": 5.0,
    "TenantID": 0
  }
}

Error Response

{
  "Message": "The request is invalid."
}

Error Handling

Status CodeLikely CauseNext Action
400 Bad RequestTaskID in the path is not an integer. A body that is not a JSON object is not refused: no field changes and the update runs as usual.Send a numeric TaskID and a JSON object body.
401 UnauthorizedMissing or invalid Bearer token.Check token validity. Learn how to create Bearer tokens →
200 with IsErrorThe caller cannot update the task (You do not have permission to update this task.).Call as someone who can edit the task.
200 with IsErrorNo task has that ID, or the update failed (There was a problem while processing your request).Verify the TaskID.
500 Server ErrorThe request has no body, and the response body is empty. Any other cause is an internal failure.Send a JSON object body. For any other 500, retry later.

Rate Limits

While Axero does not enforce hard rate limits by default, we recommend the following best practices to ensure optimal performance:

  • Sustained Request Rate: Do not exceed 5 API calls per second
  • Sequential Processing: Wait for each request to complete before sending the next in automated workflows
  • Concurrent Connections: If parallel processing is required, limit to 3 or fewer simultaneous requests
  • Response Timeout: Ensure API responses complete within 15 seconds during testing

Axero may implement temporary rate restrictions if excessive API usage affects overall site performance. For high-volume integrations, contact Axero to discuss your requirements.

Wiki Index

Pages