PATCH
/v1/me/mail/mailboxes/{id}Whether this account gets a notification on its phones when mail lands in the
inbox of one mailbox. It is this person's choice alone: switching support@
off for yourself leaves it on for your colleagues.
On by default for every mailbox of your own environment. Platform staff who can read a propfirm's mailboxes get nothing from those until they switch one on.
The path takes the mailbox's id from the list,
such as mbx_w6sy3skvgydh5e3b. A number there answers 404, like a mailbox you
cannot read.
Request
curl -X PATCH https://api.proppertrading.com/v1/me/mail/mailboxes/mbx_w6sy3skvgydh5e3b \
-H "Authorization: Bearer ptat_9f2c1a44_3b8e7d2f5c9a1b4e6d8f0a2c4e6b8d1f" \
-H "Content-Type: application/json" \
-d '{"notify": false}'
Response
The mailbox, as the list shows it.
{
"data": {
"id": "mbx_w6sy3skvgydh5e3b",
"object": "mailbox",
"email": "[email protected]",
"name": "Acme Support",
"is_catch_all": true,
"unread": 7,
"notify": false,
"channel": "private-mail-address.mbx_w6sy3skvgydh5e3b"
},
"meta": {
"request_id": "req_01kz9d4a5b6c7d8e9f0g1h2j3k"
}
}
Errors
| Status | Code | Meaning |
|---|---|---|
| 403 | insufficient_scope | This device does not hold mail:write |
| 403 | mailbox_not_permitted | The account may not open a mailbox at all |
| 404 | resource_not_found | No mailbox with that id is one you can read |
| 422 | validation_failed | notify is missing or not a boolean |