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

$ curl -X PUT https://api.awork.com/api/v1/projects/projectId/autopilot \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: application/json" \
>      -d '{
>   "type": "agile",
>   "enabled": true,
>   "alerts": [
>     {
>       "id": "123e4567-e89b-12d3-a456-426614174000",
>       "alert": "due_soon",
>       "enabled": true,
>       "channel": "email"
>     }
>   ]
> }'

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 their project role.

Required Permissions

Any authenticated user.

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 their project role. <Check title="Required Permissions" icon="key">Any authenticated user.</Check>

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. The collection must contain every alert type returned by GET /autopilot/availablealerts, including alerts that should be disabled.

Response

typestring>=1 character

The type of the autopilot.

enabledboolean

Whether the autopilot is enabled.

alertslist of objects

The alerts of the autopilot. The collection must contain every alert type returned by GET /autopilot/availablealerts, including alerts that should be disabled.

idstringOptionalformat: "uuid"

The id of the autopilot.

createdOnstringOptionalformat: "date-time"

The date this object was created.

createdBystringOptionalformat: "uuid"

The id of the user who created this object.

updatedOnstringOptionalformat: "date-time"

The date this object was last modified.

updatedBystringOptionalformat: "uuid"

The id of the user who last modified this object.