API ReferenceFolders

Create folder

Create a new mail folder with a name and optional color

Authentication

AuthorizationBearer

Your API key, sent as Authorization: Bearer usgmk_live_… in production or usgmk_test_… in the sandbox.

Request

This endpoint expects an object.
namestringRequired1-255 characters
colorstringOptionalformat: "^#[0-9a-fA-F]{6}$"

Response

idstring

Folder id (numeric string) — mail items reference it as folder_id.

namestring
created_ondatetime
updated_ondatetime
colorstring or nullOptional

Hex color like #4BB94B.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
409
Conflict Error
422
Unprocessable Entity Error
429
Too Many Requests Error
500
Internal Server Error