SupportDeveloper ForumLogin
  • Overview
    • Introduction
    • Getting Started
    • Authentication
    • Error Handling
    • Pagination
    • Filtering
    • Ordering
    • Rate Limits
    • Permissions
    • Webhooks
    • MCP Server
    • Versioning
    • Changelog
    • Support
  • API v1 Reference
    • Projects Overview
    • Tasks Overview
    • Time Tracking Overview
    • Documents Overview
    • Search Overview
    • Companies Overview
    • Users Overview
    • Files & Images Overview
    • Custom Fields Overview
    • Workload & Planning Overview
    • Project Templates Overview
    • Login & Access Overview
    • API Management Overview
LogoLogo
SupportDeveloper ForumLogin
API v1 ReferenceAutopilot

Updates the autopilot of the project with the specified id.

PUT
https://api.awork.com/api/v1/projects/:projectId/autopilot
PUT
/api/v1/projects/:projectId/autopilot
1curl -X PUT https://api.awork.com/api/v1/projects/projectId/autopilot \
2     -H "Authorization: Bearer <token>" \
3     -H "Content-Type: application/json" \
4     -d '{
5  "type": "agile",
6  "enabled": true,
7  "alerts": [
8    {
9      "id": "123e4567-e89b-12d3-a456-426614174000",
10      "alert": "due_soon",
11      "enabled": true,
12      "channel": "email"
13    }
14  ]
15}'
Try it
200Updated
1{
2  "type": "agile",
3  "enabled": true,
4  "alerts": [
5    {
6      "id": "123e4567-e89b-12d3-a456-426614174000",
7      "alert": "due_soon",
8      "enabled": true,
9      "channel": "email"
10    }
11  ],
12  "id": "123e4567-e89b-12d3-a456-426614174000",
13  "createdOn": "2024-01-15T09:30:00Z",
14  "createdBy": "123e4567-e89b-12d3-a456-426614174000",
15  "updatedOn": "2024-01-15T09:30:00Z",
16  "updatedBy": "123e4567-e89b-12d3-a456-426614174000"
17}
Updates the autopilot of the project with the specified id. To access and modify the autopilot data the user needs to be the owner of the project or must have 'read' permissions of the feature 'project-master-data' globally or in his project role. <Check title="Required Permissions">Any authenticated user.</Check>
Was this page helpful?
Previous

Deletes the autopilot of the project with the specified id.

Next
Built with
Deletes the autopilot of the project with the specified id.

Authentication

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

Path parameters

projectIdstringRequiredformat: "uuid"
The id of the project.

Request

The model used to update the autopilot.
typestringRequired>=1 character
The type of the autopilot.
enabledbooleanRequired
Whether the autopilot is enabled.
alertslist of objectsRequired
The alerts of the autopilot.

Response

OK
typestring>=1 character
The type of the autopilot.
enabledboolean
Whether the autopilot is enabled.
alertslist of objects
The alerts of the autopilot.
idstring or nullformat: "uuid"
The id of the autopilot.
createdOnstring or nullformat: "date-time"
The date this object was created.
createdBystring or nullformat: "uuid"
The id of the user who created this object.
updatedOnstring or nullformat: "date-time"
The date this object was last modified.
updatedBystring or nullformat: "uuid"
The id of the user who last modified this object.
The date this object was created.
The id of the user who created this object.
The date this object was last modified.
The id of the user who last modified this object.
The id of the project.
OK

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

Updates the autopilot of the project with the specified id. To access and modify the autopilot data the user needs to be the owner of the project or must have ‘read’ permissions of the feature ‘project-master-data’ globally or in his project role.

Required Permissions
Any authenticated user.