GOgoogle
approvals

POST /files/{fileId}/approvals:start

Changed on

Starts an approval on a file. For more information, see Manage approvals.

Request

  • Base URL
    https://www.googleapis.com/drive/v3
  • Auth
    • OAuth 2 and OAuth 2
      Implicithttps://accounts.google.com/o/oauth2/auth
      Scopeshttps://www.googleapis.com/auth/drive
      Authorization codehttps://accounts.google.com/o/oauth2/auth
      Token URLhttps://accounts.google.com/o/oauth2/token
      Scopeshttps://www.googleapis.com/auth/drive
    • or OAuth 2 and OAuth 2
      Implicithttps://accounts.google.com/o/oauth2/auth
      Scopeshttps://www.googleapis.com/auth/drive.file
      Authorization codehttps://accounts.google.com/o/oauth2/auth
      Token URLhttps://accounts.google.com/o/oauth2/token
      Scopeshttps://www.googleapis.com/auth/drive.file
    • or OAuth 2 and OAuth 2
      Implicithttps://accounts.google.com/o/oauth2/auth
      Scopeshttps://www.googleapis.com/auth/drive.metadata
      Authorization codehttps://accounts.google.com/o/oauth2/auth
      Token URLhttps://accounts.google.com/o/oauth2/token
      Scopeshttps://www.googleapis.com/auth/drive.metadata

Path parameters

fileIdstring required

Required. The ID of the file that the approval is created on.

Request body

dueTimestring google-datetime

Optional. The time that the approval is due.

fileContentChangeBehavior'FILE_CONTENT_CHANGE_BEHAVIOR_UNSPECIFIED' | 'RESET_APPROVAL' | 'NO_APPROVAL_ACTION'

Optional. The behavior of the approval when the file content changes.

lockFileboolean

Optional. Whether to lock the file when starting the approval.

messagestring

Optional. A message to send to reviewers when notifying them of the approval request.

reviewerEmailsstring[]

Required. The emails of the users who are set to review the approval.

Response

Successful response

approvalIdstring

The approval ID.

approvedRevisionIdstring

The revision ID of the file when the approval completed successfully. This is only set when the approval status is APPROVED.

completeTimestring google-datetime

The time the approval was completed.

createTimestring google-datetime

The time the approval was created.

dueTimestring google-datetime

The time that the approval is due.

fileContentChangeBehavior'FILE_CONTENT_CHANGE_BEHAVIOR_UNSPECIFIED' | 'RESET_APPROVAL' | 'NO_APPROVAL_ACTION'

The behavior of the approval when the file content changes.

kindstring

This is always drive#approval.

modifyTimestring google-datetime

The most recent time the approval was modified.

status'STATUS_UNSPECIFIED' | 'IN_PROGRESS' | 'APPROVED' | 'CANCELLED' | 'DECLINED'

The status of the approval at the time this resource was requested.

targetFileIdstring

Target file id of the approval.

Changes

  • d1fe7d8d02c7Revision changes
    • info

      the security scope https://www.googleapis.com/auth/drive was added to the endpoint's security scheme Oauth2

    • info

      the security scope https://www.googleapis.com/auth/drive was added to the endpoint's security scheme Oauth2c

    • info

      the security scope https://www.googleapis.com/auth/drive.metadata was removed from the endpoint's security scheme Oauth2

    • info

      the security scope https://www.googleapis.com/auth/drive.metadata was removed from the endpoint's security scheme Oauth2c

  • 3257eb8f178cRevision changes
    • info

      the security scope https://www.googleapis.com/auth/drive was added to the endpoint's security scheme Oauth2

    • info

      the security scope https://www.googleapis.com/auth/drive was added to the endpoint's security scheme Oauth2c

    • info

      the security scope https://www.googleapis.com/auth/drive.metadata was removed from the endpoint's security scheme Oauth2

    • info

      the security scope https://www.googleapis.com/auth/drive.metadata was removed from the endpoint's security scheme Oauth2c