Senders
Delete or archive a sender
The smart delete: a mailbox with no history is hard-deleted, one with sends, replies, or campaigns is soft-archived instead — the response’s outcome says which happened. Archived mailboxes can be restored.
DELETE
/
senders
/
{id}
import { createClient } from "@norbelys/sdk";
const norbelys = createClient({ apiKey: process.env.NORBELYS_API_KEY });
const { data, error } = await norbelys.senders.remove("snd_y3rgwmhkbgxx");
if (error) {
throw new Error(error.error.message);
}
console.log(data);
{
"outcome": "archived",
"sender": {
"bccCrmEmail": "[email protected]",
"clientLabel": "Acme Corp",
"dailyLimit": 50,
"fromEmail": "[email protected]",
"fromName": "Ada from Acme",
"id": "snd_pfh0haxfpzowht3oi213cqos",
"imapHost": "imap.gmail.com",
"imapPort": 993,
"imapSecurity": "ssl",
"minGapMinutes": 5,
"replyTo": "[email protected]",
"reputation": "good",
"sendingDomainId": "dom_tz4a98xat96iws9zmbrgj3a",
"signatureHtml": "<string>",
"smtpHost": "smtp.gmail.com",
"smtpPort": 465,
"smtpSecurity": "ssl",
"state": "healthy",
"tags": [
"acme-pool",
"us"
],
"transportMode": "smtp",
"transportProvider": "google",
"archivedAt": "<unknown>",
"createdAt": "<unknown>",
"healthUpdatedAt": "<unknown>",
"object": "sender",
"updatedAt": "<unknown>"
}
}{
"error": {
"code": "invalid_param",
"message": "<string>",
"type": "invalid_request",
"doc_url": "<string>",
"hint": "<string>"
}
}{
"error": {
"code": "invalid_param",
"message": "<string>",
"type": "invalid_request",
"doc_url": "<string>",
"hint": "<string>"
}
}{
"error": {
"code": "invalid_param",
"message": "<string>",
"type": "invalid_request",
"doc_url": "<string>",
"hint": "<string>"
}
}{
"error": {
"code": "invalid_param",
"message": "<string>",
"type": "invalid_request",
"doc_url": "<string>",
"hint": "<string>"
}
}{
"error": {
"code": "invalid_param",
"message": "<string>",
"type": "invalid_request",
"doc_url": "<string>",
"hint": "<string>"
}
}{
"error": {
"code": "invalid_param",
"message": "<string>",
"type": "invalid_request",
"doc_url": "<string>",
"hint": "<string>"
}
}{
"error": {
"code": "invalid_param",
"message": "<string>",
"type": "invalid_request",
"doc_url": "<string>",
"hint": "<string>"
}
}{
"error": {
"code": "invalid_param",
"message": "<string>",
"type": "invalid_request",
"doc_url": "<string>",
"hint": "<string>"
}
}Authorizations
Org-scoped Norbelys API key. Create one in Settings → API keys and send it as Authorization: Bearer ak_….
Path Parameters
The resource id (path).
Was this page helpful?
⌘I
import { createClient } from "@norbelys/sdk";
const norbelys = createClient({ apiKey: process.env.NORBELYS_API_KEY });
const { data, error } = await norbelys.senders.remove("snd_y3rgwmhkbgxx");
if (error) {
throw new Error(error.error.message);
}
console.log(data);
{
"outcome": "archived",
"sender": {
"bccCrmEmail": "[email protected]",
"clientLabel": "Acme Corp",
"dailyLimit": 50,
"fromEmail": "[email protected]",
"fromName": "Ada from Acme",
"id": "snd_pfh0haxfpzowht3oi213cqos",
"imapHost": "imap.gmail.com",
"imapPort": 993,
"imapSecurity": "ssl",
"minGapMinutes": 5,
"replyTo": "[email protected]",
"reputation": "good",
"sendingDomainId": "dom_tz4a98xat96iws9zmbrgj3a",
"signatureHtml": "<string>",
"smtpHost": "smtp.gmail.com",
"smtpPort": 465,
"smtpSecurity": "ssl",
"state": "healthy",
"tags": [
"acme-pool",
"us"
],
"transportMode": "smtp",
"transportProvider": "google",
"archivedAt": "<unknown>",
"createdAt": "<unknown>",
"healthUpdatedAt": "<unknown>",
"object": "sender",
"updatedAt": "<unknown>"
}
}{
"error": {
"code": "invalid_param",
"message": "<string>",
"type": "invalid_request",
"doc_url": "<string>",
"hint": "<string>"
}
}{
"error": {
"code": "invalid_param",
"message": "<string>",
"type": "invalid_request",
"doc_url": "<string>",
"hint": "<string>"
}
}{
"error": {
"code": "invalid_param",
"message": "<string>",
"type": "invalid_request",
"doc_url": "<string>",
"hint": "<string>"
}
}{
"error": {
"code": "invalid_param",
"message": "<string>",
"type": "invalid_request",
"doc_url": "<string>",
"hint": "<string>"
}
}{
"error": {
"code": "invalid_param",
"message": "<string>",
"type": "invalid_request",
"doc_url": "<string>",
"hint": "<string>"
}
}{
"error": {
"code": "invalid_param",
"message": "<string>",
"type": "invalid_request",
"doc_url": "<string>",
"hint": "<string>"
}
}{
"error": {
"code": "invalid_param",
"message": "<string>",
"type": "invalid_request",
"doc_url": "<string>",
"hint": "<string>"
}
}{
"error": {
"code": "invalid_param",
"message": "<string>",
"type": "invalid_request",
"doc_url": "<string>",
"hint": "<string>"
}
}