Workflows · Frontify GraphQL

Mutation

addWorkflowChecklistItem

Add a new WorkflowChecklistItem for a given WorkflowTask. Requires basic:write scope to be accessible and Project permission level EDIT.

Beta

Returns

AddWorkflowChecklistItem

Arguments

input:AddWorkflowChecklistItemInput!RequiredBeta: AddWorkflowChecklistItem input argument.; Requiredid: ID!, content: String!; OptionalisCompleted: Boolean, assigneeUserId: ID

Response fields

0 selected

Toggle fields to tailor the query and response.

Example

mutation AddWorkflowChecklistItem {
  addWorkflowChecklistItem(
    input: {
      id: 
      content: 
      
      
    }
  ) {
    __typename
  }
}

Example response

{
  "data": {
    "addWorkflowChecklistItem": {
      "__typename": "AddWorkflowChecklistItem"
    }
  }
}

Mutation

addWorkflowChecklistPreset

Open full page ↗Raw SDL

Add a new WorkflowChecklistPreset for a given WorkflowStatus. Requires basic:write scope to be accessible and Project permission level EDIT.

Beta

Returns

AddWorkflowChecklistPreset

Arguments

input:AddWorkflowChecklistPresetInput!RequiredBeta: AddWorkflowChecklistPreset input argument.; Requiredid: ID!, content: String!; OptionalassigneeUserId: ID

Response fields

0 selected

Toggle fields to tailor the query and response.

Example

mutation AddWorkflowChecklistPreset {
  addWorkflowChecklistPreset(
    input: {
      id: 
      content: 
      
    }
  ) {
    __typename
  }
}

Example response

{
  "data": {
    "addWorkflowChecklistPreset": {
      "__typename": "AddWorkflowChecklistPreset"
    }
  }
}

Mutation

addWorkflowStatusAssignees

Open full page ↗Raw SDL

Add assignees to an existing WorkflowStatus. Currently, only one assignee is supported. Requires basic:write scope to be accessible and Project permission level EDIT.

Beta

Returns

AddWorkflowStatusAssignees

Arguments

input:AddWorkflowStatusAssigneesInput!RequiredBeta: AddWorkflowStatusAssignees input argument.; Requiredid: ID!, userIds: [ID!]!

Response fields

0 selected

Toggle fields to tailor the query and response.

Example

mutation AddWorkflowStatusAssignees {
  addWorkflowStatusAssignees(
    input: {
      id: 
      userIds: []
    }
  ) {
    __typename
  }
}

Example response

{
  "data": {
    "addWorkflowStatusAssignees": {
      "__typename": "AddWorkflowStatusAssignees"
    }
  }
}

Mutation

addWorkflowTaskAssignees

Open full page ↗Raw SDL

Add assignees to an existing WorkflowTask. Requires basic:write scope to be accessible and Project permission level EDIT.

Beta

Returns

AddWorkflowTaskAssignees

Arguments

input:AddWorkflowTaskAssigneesInput!RequiredBeta: AddWorkflowTaskAssignees input argument.; Requiredid: ID!, userIds: [ID!]!

Response fields

0 selected

Toggle fields to tailor the query and response.

Example

mutation AddWorkflowTaskAssignees {
  addWorkflowTaskAssignees(
    input: {
      id: 
      userIds: []
    }
  ) {
    __typename
  }
}

Example response

{
  "data": {
    "addWorkflowTaskAssignees": {
      "__typename": "AddWorkflowTaskAssignees"
    }
  }
}

Mutation

createWorkflowStatus

Open full page ↗Raw SDL

Create new WorkflowStatus in a given Workflow. Requires basic:write scope to be accessible and Project permission level EDIT.

Beta

Returns

CreateWorkflowStatus

Arguments

input:CreateWorkflowStatusInput!RequiredBeta: CreateWorkflowStatus input argument.; RequiredworkflowId: ID!, title: String!; Optionalcolor: RgbaColorInput

Response fields

0 selected

Toggle fields to tailor the query and response.

Example

mutation CreateWorkflowStatus {
  createWorkflowStatus(
    input: {
      workflowId: 
      title: 
      
    }
  ) {
    __typename
  }
}

Example response

{
  "data": {
    "createWorkflowStatus": {
      "__typename": "CreateWorkflowStatus"
    }
  }
}

Mutation

deleteWorkflowStatus

Open full page ↗Raw SDL

Delete an existing WorkflowStatus. Requires basic:write scope to be accessible and Project permission level EDIT.

Beta

Returns

DeleteWorkflowStatus

Arguments

input:DeleteWorkflowStatusInput!RequiredBeta: DeleteWorkflowStatus input argument.; Requiredid: ID!

Response fields

1 selected

Toggle fields to tailor the query and response.

idID!

Example

mutation DeleteWorkflowStatus {
  deleteWorkflowStatus(
    input: {
      id: 
    }
  ) {
    __typename
    id
  }
}

Example response

{
  "data": {
    "deleteWorkflowStatus": {
      "__typename": "DeleteWorkflowStatus",
      "id": "eyJXXXXXXXX…"
    }
  }
}

Mutation

deleteWorkflowTask

Open full page ↗Raw SDL

Delete an existing WorkflowTask. Requires basic:write scope to be accessible and Project permission level EDIT.

Beta

Returns

DeleteWorkflowTask

Arguments

input:DeleteWorkflowTaskInput!RequiredBeta: DeleteWorkflowTask input argument.; Requiredid: ID!

Response fields

1 selected

Toggle fields to tailor the query and response.

idID!

Example

mutation DeleteWorkflowTask {
  deleteWorkflowTask(
    input: {
      id: 
    }
  ) {
    __typename
    id
  }
}

Example response

{
  "data": {
    "deleteWorkflowTask": {
      "__typename": "DeleteWorkflowTask",
      "id": "eyJXXXXXXXX…"
    }
  }
}

Mutation

moveWorkflowTask

Open full page ↗Raw SDL

Move one or more WorkflowTask to a new WorkflowStatus. All EnterRule of the destination WorkflowStatus have to be satisfied to be able to move. Requires basic:write scope to be accessible and Project permission level EDIT.

Beta

Returns

MoveWorkflowTask

Arguments

input:MoveWorkflowTaskInput!RequiredBeta: MoveWorkflowTask input argument.; RequiredworkflowStatusId: ID!, workflowTaskIds: [ID!]!; OptionalstatusEnterMessage: String

Response fields

0 selected

Toggle fields to tailor the query and response.

Example

mutation MoveWorkflowTask {
  moveWorkflowTask(
    input: {
      workflowStatusId: 
      workflowTaskIds: []
      
    }
  ) {
    __typename
  }
}

Example response

{
  "data": {
    "moveWorkflowTask": {
      "__typename": "MoveWorkflowTask"
    }
  }
}

Mutation

removeWorkflowChecklistItem

Open full page ↗Raw SDL

Remove a WorkflowChecklistItem.Requires basic:write scope to be accessible and Project permission level EDIT.

Beta

Returns

RemoveWorkflowChecklistItem

Arguments

input:RemoveWorkflowChecklistItemInput!RequiredBeta: RemoveWorkflowChecklistItem input argument.; Requiredid: ID!

Response fields

0 selected

Toggle fields to tailor the query and response.

Example

mutation RemoveWorkflowChecklistItem {
  removeWorkflowChecklistItem(
    input: {
      id: 
    }
  ) {
    __typename
  }
}

Example response

{
  "data": {
    "removeWorkflowChecklistItem": {
      "__typename": "RemoveWorkflowChecklistItem"
    }
  }
}

Mutation

removeWorkflowChecklistPreset

Open full page ↗Raw SDL

Remove a WorkflowChecklistPreset.Requires basic:write scope to be accessible and Project permission level EDIT.

Beta

Returns

RemoveWorkflowChecklistPreset

Arguments

input:RemoveWorkflowChecklistPresetInput!RequiredBeta: RemoveWorkflowChecklistPreset input argument.; Requiredid: ID!

Response fields

0 selected

Toggle fields to tailor the query and response.

Example

mutation RemoveWorkflowChecklistPreset {
  removeWorkflowChecklistPreset(
    input: {
      id: 
    }
  ) {
    __typename
  }
}

Example response

{
  "data": {
    "removeWorkflowChecklistPreset": {
      "__typename": "RemoveWorkflowChecklistPreset"
    }
  }
}

Mutation

removeWorkflowStatusAssignees

Open full page ↗Raw SDL

Remove assignees from an existing WorkflowStatus. Requires basic:write scope to be accessible and Project permission level EDIT.

Beta

Returns

RemoveWorkflowStatusAssignees

Arguments

input:RemoveWorkflowStatusAssigneesInput!RequiredBeta: RemoveWorkflowStatusAssignees input argument.; Requiredid: ID!, userIds: [ID!]!

Response fields

0 selected

Toggle fields to tailor the query and response.

Example

mutation RemoveWorkflowStatusAssignees {
  removeWorkflowStatusAssignees(
    input: {
      id: 
      userIds: []
    }
  ) {
    __typename
  }
}

Example response

{
  "data": {
    "removeWorkflowStatusAssignees": {
      "__typename": "RemoveWorkflowStatusAssignees"
    }
  }
}

Mutation

removeWorkflowTaskAssignees

Open full page ↗Raw SDL

Remove assignees from an existing WorkflowTask. Requires basic:write scope to be accessible and Project permission level EDIT.

Beta

Returns

RemoveWorkflowTaskAssignees

Arguments

input:RemoveWorkflowTaskAssigneesInput!RequiredBeta: RemoveWorkflowTaskAssignees input argument.; Requiredid: ID!, userIds: [ID!]!

Response fields

0 selected

Toggle fields to tailor the query and response.

Example

mutation RemoveWorkflowTaskAssignees {
  removeWorkflowTaskAssignees(
    input: {
      id: 
      userIds: []
    }
  ) {
    __typename
  }
}

Example response

{
  "data": {
    "removeWorkflowTaskAssignees": {
      "__typename": "RemoveWorkflowTaskAssignees"
    }
  }
}

Mutation

updateWorkflowChecklistItem

Open full page ↗Raw SDL

Update an existing WorkflowChecklistItem. Requires basic:write scope to be accessible and Project permission level EDIT.

Beta

Returns

UpdateWorkflowChecklistItem

Arguments

input:UpdateWorkflowChecklistItemInput!RequiredBeta: UpdateWorkflowChecklistItem input argument.; Requiredid: ID!, data: UpdateWorkflowChecklistItemDataInput!

Response fields

0 selected

Toggle fields to tailor the query and response.

Example

mutation UpdateWorkflowChecklistItem {
  updateWorkflowChecklistItem(
    input: {
      id: 
      data: {
        
        
        
      }
    }
  ) {
    __typename
  }
}

Example response

{
  "data": {
    "updateWorkflowChecklistItem": {
      "__typename": "UpdateWorkflowChecklistItem"
    }
  }
}

Mutation

updateWorkflowChecklistPreset

Open full page ↗Raw SDL

Update an existing WorkflowChecklistPreset. Requires basic:write scope to be accessible and Project permission level EDIT.

Beta

Returns

UpdateWorkflowChecklistPreset

Arguments

input:UpdateWorkflowChecklistPresetInput!RequiredBeta: UpdateWorkflowChecklistPreset input argument.; Requiredid: ID!, data: UpdateWorkflowChecklistPresetDataInput!

Response fields

0 selected

Toggle fields to tailor the query and response.

Example

mutation UpdateWorkflowChecklistPreset {
  updateWorkflowChecklistPreset(
    input: {
      id: 
      data: {
        
        
      }
    }
  ) {
    __typename
  }
}

Example response

{
  "data": {
    "updateWorkflowChecklistPreset": {
      "__typename": "UpdateWorkflowChecklistPreset"
    }
  }
}

Mutation

updateWorkflowStatus

Open full page ↗Raw SDL

Update an existing WorkflowStatus. Requires basic:write scope to be accessible and Project permission level EDIT.

Beta

Returns

UpdateWorkflowStatus

Arguments

input:UpdateWorkflowStatusInput!RequiredBeta: UpdateWorkflowStatus input argument.; Requiredid: ID!, data: UpdateWorkflowStatusDataInput!

Response fields

0 selected

Toggle fields to tailor the query and response.

Example

mutation UpdateWorkflowStatus {
  updateWorkflowStatus(
    input: {
      id: 
      data: {
        
        
      }
    }
  ) {
    __typename
  }
}

Example response

{
  "data": {
    "updateWorkflowStatus": {
      "__typename": "UpdateWorkflowStatus"
    }
  }
}

Mutation

updateWorkflowTask

Open full page ↗Raw SDL

Update an existing WorkflowTask. Requires basic:write scope to be accessible and Project permission level EDIT.

Beta

Returns

UpdateWorkflowTask

Arguments

input:UpdateWorkflowTaskInput!RequiredBeta: UpdateWorkflowTask input argument.; Requiredid: ID!, data: UpdateWorkflowTaskDataInput!

Response fields

0 selected

Toggle fields to tailor the query and response.

Example

mutation UpdateWorkflowTask {
  updateWorkflowTask(
    input: {
      id: 
      data: {
        
        
      }
    }
  ) {
    __typename
  }
}

Example response

{
  "data": {
    "updateWorkflowTask": {
      "__typename": "UpdateWorkflowTask"
    }
  }
}