Delete a mailbox label
Deletes a label and removes it from every thread that carries it. Request: DELETE /v1/mailboxes/{id}/labels/{labelId}. Scope: mailboxes:manage.
DELETE
Deletes a label and removes it from every thread that carries it.
apiKeyheader
x-api-key<token>id*stringMatch
^mbx_[0-9a-hjkmnp-tv-z]{16,24}$labelId*stringMatch
^label_[0-9a-hjkmnp-tv-z]{16,24}$SuccessResponse
application/json- response
success*booleanimport { createClient } from "samva";
const samva = createClient({ apiKey: process.env.SAMVA_API_KEY! });
const result = await samva.mailboxes.deleteLabel({
"id": "example",
"labelId": "example"
});Example Response
{
"success": true
}