autessa.gmail
9 methods in the gmail namespace.
autessa.gmail.connectors.allREAD
autessa.gmail.connectors.all()List every Gmail connector you can access in your company.
Returns all Gmail connectors in your current company that you have at least READ access to, newest-relevant first. Use a connector's connectorId with the other gmail.connectors.* methods. Credentials are never included in the returned DTOs.
Request fields
No fields.
Response fields
- Name
errors- Type
- string[]
- Description
- Name
deprecationWarnings- Type
- string[]
- Description
- Name
sessionToken- Type
- string
- Description
- Name
connectors- Type
- GmailConnectorDto[]
- Description
autessa.gmail.connectors.deleteMUTATE
autessa.gmail.connectors.delete({ connectorId })Permanently delete a Gmail connector and its stored credential.
Removes the Gmail connector for connectorId, revoking every tool and script that relied on it. The stored credential is destroyed and cannot be recovered — reconnecting requires the full auth flow again. Requires WRITE (owner-level) access.
Request fields
- Name
connectorId- Type
- string (opaque id)
- Description
- References external connector by opaque id.
Response fields
- Name
errors- Type
- string[]
- Description
- Name
deprecationWarnings- Type
- string[]
- Description
- Name
sessionToken- Type
- string
- Description
- Name
message- Type
- string
- Description
autessa.gmail.connectors.getREAD
autessa.gmail.connectors.get({ connectorId })Fetch one Gmail connector by id.
Returns the full Gmail connector for connectorId, including its sharing/active state and the linked account metadata — but never the stored credential. Fails if you lack READ access to the connector.
Request fields
- Name
connectorId- Type
- string (opaque id)
- Description
- References external connector by opaque id.
Response fields
- Name
errors- Type
- string[]
- Description
- Name
deprecationWarnings- Type
- string[]
- Description
- Name
sessionToken- Type
- string
- Description
- Name
connector- Type
- GmailConnectorDto
- Description
autessa.gmail.connectors.getSharingDetailsREAD
autessa.gmail.connectors.getSharingDetails({ connectorId })Read the current sharing configuration of a Gmail connector.
Returns how the Gmail connector is shared: the overall sharingLevel, the companyPermissionLevel granted for COMPANY sharing, the explicit sharedWith members, and your own userAccessLevel. Use before share to see the current state.
Request fields
- Name
connectorId- Type
- string (opaque id)
- Description
- References external connector by opaque id.
Response fields
- Name
errors- Type
- string[]
- Description
- Name
deprecationWarnings- Type
- string[]
- Description
- Name
sessionToken- Type
- string
- Description
- Name
sharingLevel- Type
- "PRIVATE" | "SPECIFIC_MEMBER" | "COMPANY"
- Description
- Name
companyPermissionLevel- Type
- "READ" | "WRITE" | "PUBLISH" | "ADMIN"
- Description
- Name
sharedWith- Type
- UserShareWrapper[]
- Description
- Name
userAccessLevel- Type
- "READ" | "WRITE" | "PUBLISH" | "ADMIN"
- Description
autessa.gmail.connectors.updateMUTATE
autessa.gmail.connectors.update({ connectorId, connectorName, isActive })Rename a Gmail connector or toggle whether it is active.
Applies a sparse patch to the Gmail connector for connectorId: send connectorName to rename it, isActive to enable/disable it. This is a partial update — omit a field to leave it unchanged; sending null or an empty name is ignored. Does not touch the stored credential or sharing. Requires WRITE access.
Request fields
- Name
connectorId- Type
- string (opaque id)
- Description
- References external connector by opaque id.
- Name
connectorName- Type
- string
- Description
- Name
isActive- Type
- boolean
- Description
Response fields
- Name
errors- Type
- string[]
- Description
- Name
deprecationWarnings- Type
- string[]
- Description
- Name
sessionToken- Type
- string
- Description
- Name
message- Type
- string
- Description
- Name
connector- Type
- GmailConnectorDto
- Description
autessa.gmail.connectors.updateAvailableLabelsMUTATE
autessa.gmail.connectors.updateAvailableLabels({ connectorId, labelsToEnable, labelsToDisable })Enable or disable specific Gmail labels on a connector.
Toggles which of the connector's stored Gmail labels are usable by tools: pass label ids in labelsToEnable to enable them and in labelsToDisable to disable them. Only enabled labels can be used by tools that read Gmail through this connector. Returns the resulting set of enabled labels. Requires WRITE access.
Request fields
- Name
connectorId- Type
- string (opaque id)
- Description
- References external connector by opaque id.
- Name
labelsToEnable- Type
- string[]
- Description
- Name
labelsToDisable- Type
- string[]
- Description
Response fields
- Name
errors- Type
- string[]
- Description
- Name
deprecationWarnings- Type
- string[]
- Description
- Name
sessionToken- Type
- string
- Description
- Name
message- Type
- string
- Description
- Name
enabledLabels- Type
- LabelDto[]
- Description
autessa.gmail.connectors.viewAvailableLabelsREAD
autessa.gmail.connectors.viewAvailableLabels({ connectorId })List the Gmail labels stored for a connector, both enabled and disabled.
Returns every Gmail label recorded for this connector in the database — enabled and disabled alike — with each label's id, name, type, and whether it is currently enabled for use by tools. This reads stored metadata and does not make a live Gmail call. Use it before updateAvailableLabels to see what can be toggled.
Request fields
- Name
connectorId- Type
- string (opaque id)
- Description
- References external connector by opaque id.
Response fields
- Name
errors- Type
- string[]
- Description
- Name
deprecationWarnings- Type
- string[]
- Description
- Name
sessionToken- Type
- string
- Description
- Name
labels- Type
- LabelDto[]
- Description