Folders

Create a Folder

Creates a folder.

post/v3/grants/{grant_id}/folders

Query parameters

selectstring

Specify fields that you want Nylas to return, as a comma-separated list (for example, select=id,updated_at). This allows you to receive only the portion of object data that you're interested in. You can use select to optimize response size and reduce latency by limiting queries to only the information that you need.

shared_fromstring

(Microsoft only) When provided, Nylas returns items that were shared from the specified email address. It also accepts grant ID. This parameter only accepts single email address or grant ID. Check out the Shared folders guide for more information.

Request body

namestring required

Creates a folder with the specified display name.

parent_idstring

(Microsoft and EWS only) The ID of the parent folder.

text_colorstring

(Google only) The text color of the folder, in hexadecimal format (for example, #0099EE). See the list of Google-defined values for more information.

background_colorstring

(Google only) The background color of the folder, in hexadecimal format (for example, #0099EE). See the list of Google-defined values for more information.

Response

Folder

request_idstring

The request ID.

Example response

{
  "request_id": "5fa64c92-e840-4357-86b9-2aa364d35b88"
}

Changes

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