Automatically group grants into workspace - Workspaces - API Reference

POST

/v3/workspaces/auto-group

Configures automatic grouping settings for new or existing workspaces, depending on the filters set. If you don't set any filters, Nylas considers all grants.

NYLAS API KEY

Request body

after_created_atnumber

Applies automatic grouping settings to grants created at or after the specified time, in seconds using the Unix timestamp format.

Example: 1622548800000

invalid_alsoboolean

When true, applies automatic grouping settings to both invalid and valid grants. When false, applies settings to valid grants only.

Default: false

Example: false

specific_domainstring

Applies automatic grouping settings to grants with the specified email domain only.

Example: "nylas.com"

with_grant_workspace_idboolean

When true, applies automatic grouping settings to only grants that are already assigned to a workspace.

Default: false

Example: false

Responses

request_idstring

The request ID.

Example: "5967ca40-a2d8-4ee0-a0e0-6f18ace39a90"

dataobject

curl --request POST \ --url "https://api.us.nylas.com/v3/workspaces/auto-group" \ --header 'Accept: application/json' \ --header 'Authorization: Bearer <NYLAS_API_KEY>' \ --header 'Content-Type: application/json' \ --data '{ "after_created_at": 1725273600, "invalid_also": true, "specific_domain": "nylas.com", "with_grant_workspace_id": false }'