Sign in
Workspaces

Automatically group grants into workspace

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.

post/v3/workspaces/auto-group

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.

invalid_alsoboolean

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

specific_domainstring

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

Example request

{
  "after_created_at": 1622548800,
  "specific_domain": "nylas.com"
}

Response

Success. Returns a information about automatic grouping job.

request_idstring

The request ID.

Example response

{
  "request_id": "5967ca40-a2d8-4ee0-a0e0-6f18ace39a90",
  "data": {
    "job_id": "52e61713-ab00-4d70-8974-73cf541c5db9",
    "message": "Auto-grouping started successfully under JobID '52e61713-ab00-4d70-8974-73cf541c5db9', please wait for the process to complete. It may take some time."
  }
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.