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 21

REST API: Update Task

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

Supports the synchronization and modification of update task properties via the API.

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 JSONStringYESBodyJSON representing the task

Optional Parameters

ParameterTypeRequiredLocationDescription
TaskNameStringNOBodyDisplay name for the task. Appears in task lists and notifications.
TaskListIDIntegerNOBodyID of the task list to add the task to
SpaceIDIntegerNOBodyID of the space the task list is in
TaskDescriptionStringNOBodyDetailed description of the task, supporting plain text.
AssignedToUserIDIntegerNOBodyID of the user to assign the task to
TaskStatusIDIntegerNOBodyID of the task status to set
TaskPriorityIDIntegerNOBodyID of the task priority to set
TaskDueDateStringNOBodyDue date for the task in ISO 8601 format (e.g., 2026-03-15T00:00:00Z).
TaskEstimatedHoursIntegerNOBodyThe task's estimated completion time in hours
FollowerUserNamesCsvStringNOBodyA comma-separated list of usernames of users to add as task 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 analyze financial data for the Q4     report, ensuring accuracy and completeness.",
  "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": 734,
    "TaskName": "Prepare Q4 Financial Report"
  }
}

Error Response

{
  "IsError": true,
  "ResponseMessage": "Required parameter is missing or invalid.",
  "ResponseData": null
}

Error Handling

Status CodeLikely CauseNext Action
400 Bad RequestOne or more required fields are missing or invalid. (taskID, source)Verify the request payload against the required parameters.
401 UnauthorizedMissing or invalid Bearer token.Check token validity. Learn how to create Bearer tokens →
403 ForbiddenUser does not have sufficient permissions.Confirm the user has the required roles for this action.
404 Not FoundThe specified task was not found.Verify the taskID is correct.
500 Server ErrorInternal failure.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