v1
latestOpenAPI 3.1.02026-07-14159142161.9 KBemailService
Add Email Settings
Adds settings for an email account, including folder configurations and access roles. Only accessible by authorized users.
post/email/v1/emails/settings/{emailId}
Path parameters
emailIdinteger required
Example:10
The ID of the email
Request body
Example request
{
"name": "Name",
"sender_name": "Sender Name",
"access_level": "shared",
"access_roles": [
{
"user_id": 5,
"name": "viewer"
}
],
"sync_from": {
"period": "1 year"
},
"folders": [
[
{
"folder_name": "INBOX",
"path": "INBOX",
"delimitter": "/",
"is_inbox": true,
"is_root": true
},
{
"folder_name": "Sent Mail",
"path": "[Gmail]/Sent Mail",
"delimitter": "/",
"is_sent": true
},
{
"folder_name": "Drafts",
"path": "[Gmail]/Drafts",
"delimitter": "/",
"is_draft": true
},
{
"folder_name": "Trash",
"path": "[Gmail]/Trash",
"delimitter": "/",
"is_trash": true
}
]
],
"crm_integration_enabled": true
}Response
OK
Example response
{
"id": 10,
"name": "Name",
"sender_name": "Sender Name",
"access_level": "shared",
"access_roles": [
{
"user_id": 5,
"name": "viewer"
}
],
"folders": [
[
{
"id": 61,
"email_id": 10,
"parent_id": null,
"folder_name": "INBOX",
"path": "INBOX",
"delimitter": "/",
"is_trash": false,
"is_spam": false,
"is_draft": false,
"is_junk": false,
"is_sent": false,
"is_inbox": true,
"is_pending": false,
"has_children": false,
"is_root": true,
"is_deleted": false,
"message_count": 4998,
"unread_message_count": 43
},
{
"id": 64,
"email_id": 10,
"parent_id": null,
"folder_name": "Sent Mail",
"path": "[Gmail]/Sent Mail",
"delimitter": "/",
"is_trash": false,
"is_spam": false,
"is_draft": false,
"is_junk": false,
"is_sent": true,
"is_inbox": false,
"is_pending": false,
"has_children": false,
"is_root": false,
"is_deleted": false,
"message_count": 248,
"unread_message_count": 0
},
{
"id": 63,
"email_id": 10,
"parent_id": null,
"folder_name": "Drafts",
"path": "[Gmail]/Drafts",
"delimitter": "/",
"is_trash": false,
"is_spam": false,
"is_draft": true,
"is_junk": false,
"is_sent": false,
"is_inbox": false,
"is_pending": false,
"has_children": false,
"is_root": false,
"is_deleted": false,
"message_count": 73,
"unread_message_count": 0
},
{
"id": 66,
"email_id": 10,
"parent_id": null,
"folder_name": "Trash",
"path": "[Gmail]/Trash",
"delimitter": "/",
"is_trash": true,
"is_spam": false,
"is_draft": false,
"is_junk": false,
"is_sent": false,
"is_inbox": false,
"is_pending": false,
"has_children": false,
"is_root": false,
"is_deleted": false,
"message_count": 7612,
"unread_message_count": 0
}
]
],
"crm_integration_enabled": true
}