Skip to main content
PATCH
cURL

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Scopes

https://www.googleapis.com/auth/userinfo.email
google_id_token-a99f12e0

View your email address

https://www.googleapis.com/auth/userinfo.email
google_id_token_legacy-a99f12e0

View your email address

Path Parameters

workflowId
string
required

The ID of the workflow

Query Parameters

domain
string

The G Suite domain

securityCode
string

The security code

Body

application/json
allowNotificationForAllExternalUsers
boolean

Whether to allow sending notifications also for non-whitelisted external users/groups

classId
string

The ID of the document class (read-only field)

className
string

The name of the document class (read-only field)

createdTime
string<date-time>

The time at which the workflow was created (read-only field)

id
string

The ID of the workflow (read-only field)

initialStateId
string

The ID of the initial state (read-only field)

kind
string
lastModifiedTime
string<date-time>

The time at which the workflow was last modified (read-only field)

libraryId
string

The ID of the library (read-only field)

libraryName
string

The name of the library (read-only field)

muteNotifications
boolean

Whether to mute email notifications

name
string

The name of the workflow

states
object[]

The list of workflow states

Response

200 - application/json

A ApiWorkflow response

allowNotificationForAllExternalUsers
boolean

Whether to allow sending notifications also for non-whitelisted external users/groups

classId
string

The ID of the document class (read-only field)

className
string

The name of the document class (read-only field)

createdTime
string<date-time>

The time at which the workflow was created (read-only field)

id
string

The ID of the workflow (read-only field)

initialStateId
string

The ID of the initial state (read-only field)

kind
string
lastModifiedTime
string<date-time>

The time at which the workflow was last modified (read-only field)

libraryId
string

The ID of the library (read-only field)

libraryName
string

The name of the library (read-only field)

muteNotifications
boolean

Whether to mute email notifications

name
string

The name of the workflow

states
object[]

The list of workflow states