Get a sender
Returns one sender owned by the authenticated organization. Other organizations' ids are reported as not found.
Returns one sender owned by the authenticated organization. Other organizations' ids are reported as not found.
apiKeyx-api-key<token>id*string^sender_[0-9a-hjkmnp-tv-z]{16,24}$Success
application/json- response
id*EmailSenderId^sender_[0-9a-hjkmnp-tv-z]{16,24}$organizationId*stringemail*stringname*string|nulldomainId*|nullnamespaceId*|The namespace the sender belongs to, or null at organization level. A sender on a domain takes the domain's namespace.
verificationStatus*string"pending""verified""failed"verifiedAt*string|nullverificationToken*string|nullproviderLifecycle*string"provisioning""active""deleting""failed"providerFailureCode*string|nullisDefault*booleanreplyToEmails*array<string>|nulldeliverability*Bounce and complaint rates over the last 24 hours, as fractions between 0 and 1, with windowSends, the deliveries they were divided by, plus sendingStatus, which says whether the organization can currently send. The window matches the one the sending-pause rule reads. Below 200 sends that rule ignores the window entirely, so a rate over a smaller windowSends is a quotient rather than a reading. These are not a lifetime record; an identity with no traffic in the window reports zeroes.
series*array<>Daily email sends for the last 14 calendar days in the organization's own timezone, oldest first and zero-filled. Always fourteen entries; an entity that has never sent reports fourteen zeroes.
isActive*booleancreatedAt*stringupdatedAt*stringimport { createClient } from "samva";const samva = createClient({ apiKey: process.env.SAMVA_API_KEY! });const result = await samva.email.getSender({ "id": "example"});{ "id": "string", "organizationId": "string", "email": "string", "name": "string", "domainId": "string", "namespaceId": "string", "verificationStatus": "pending", "verifiedAt": "string", "verificationToken": "string", "providerLifecycle": "provisioning", "providerFailureCode": "string", "isDefault": true, "replyToEmails": [ "string" ], "deliverability": { "bounceRate": 0, "complaintRate": 0, "windowSends": 0, "sendingStatus": "enabled" }, "series": [ 0 ], "isActive": true, "createdAt": "string", "updatedAt": "string"}