Updates the automation with the specified id for a given projecttemplate. | awork API

import requests
url = "https://api.awork.com/api/v1/projecttemplates/projectTemplateId/automations/automationId"
payload = {
    "enabled": True,
    "trigger": { "type": "task-created" }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.json())

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "createdBy": "123e4567-e89b-12d3-a456-426614174000",
  "createdOn": "2024-01-15T09:30:00Z",
  "updatedBy": "123e4567-e89b-12d3-a456-426614174000",
  "updatedOn": "2024-01-15T09:30:00Z",
  "triggerId": "123e4567-e89b-12d3-a456-426614174000",
  "trigger": {
    "updatedOn": "2024-01-15T09:30:00Z",
    "type": "task-created",
    "values": [
      {
        "name": "name",
        "value": "Design"
      }
    ]
  },
  "enabled": true,
  "state": "string",
  "createdByProjectTemplate": false,
  "projectId": "123e4567-e89b-12d3-a456-426614174000",
  "projectTemplateId": "123e4567-e89b-12d3-a456-426614174000",
  "actions": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "createdBy": "123e4567-e89b-12d3-a456-426614174000",
      "createdOn": "2024-01-15T09:30:00Z",
      "updatedBy": "123e4567-e89b-12d3-a456-426614174000",
      "updatedOn": "2024-01-15T09:30:00Z",
      "type": "tag-add-task",
      "order": 2,
      "values": [
        {
          "name": "tag",
          "value": "Design"
        }
      ]
    }
  ],
  "workflowId": "123e4567-e89b-12d3-a456-426614174000",
  "createdByAutomationIdFromWorkflow": "123e4567-e89b-12d3-a456-426614174000",
  "failed": {
    "code": "not-found",
    "description": "There is no matching path for this URL.",
    "link": "https://developers.awork.com",
    "details": [
      "No project with the id '123' exists."
    ],
    "validationErrors": [
      {
        "property": "FirstName",
        "message": "FirstName is required."
      }
    ],
    "traceId": "a65ce5745df02af216715ff06661fb3a"
  }
}

Updates the specified automation for a specific projecttemplate. If the automation was created from a workflow, only the Enabled flag can be changed.

Required Permissions

The user must be an admin or have project-manage-config:write permissions.

Updates the specified automation for a specific projecttemplate. If the automation was created from a workflow, only the Enabled flag can be changed. <Check title="Required Permissions" icon="key">The user must be an admin or have `project-manage-config:write` permissions.</Check>

Authentication

AuthorizationBearer

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

Path parameters

automationIdstringRequiredformat: "uuid"

projectTemplateIdstringRequiredformat: "uuid"

Request

This endpoint expects an object.

enabledbooleanRequired

Whether the automation is enabled.

triggerobjectRequired

Response

idstringformat: "uuid"

The id of the automation.

createdBystringformat: "uuid"

The id of the user who created the automation.

createdOndatetime

The date the automation was created.

updatedBystringformat: "uuid"

The id of the user who updated the automation.

updatedOndatetime

The date the automation was updated.

triggerIdstringformat: "uuid"

The id of the trigger which is related to the automation.

triggerobject

enabledbooleanRead-only

Whether the automation is enabled.

statestring or null

The state of the automation. See AutomationsService.DAL.Models.AutomationState for the possible values.

createdByProjectTemplateboolean

Whether the automation was created from an automation template of a project template.

projectIdstring or nullformat: "uuid"

The id of the project which is related to the automation.

projectTemplateIdstring or nullformat: "uuid"

The id of the project template which is related to the automation.

actionslist of objects or null

The actions which is related to the automation.

workflowIdstring or nullformat: "uuid"

The workflow this automation belongs to, if any.

createdByAutomationIdFromWorkflowstring or nullformat: "uuid"

The id of the workflow automation that served as the template for this automation.

failedobject

The API error response.

Errors

400

Bad Request Error