Add a sender
Creates a sender. View request and response details for this Samva email API endpoint.
POST
Creates a sender. A sender on a domain takes the domain's namespace, and a namespaceId that names another namespace is refused; a sender with no domain joins namespaceId, or its key's namespace. A namespace-scoped key cannot add a sender on a domain outside its namespace. The required Idempotency-Key replays the original sender for an identical request and conflicts when reused with different input.
apiKeyheader
x-api-key<token>idempotency-key*stringLength
1 <= length <= 255application/json- body
email*stringdomainId?|nullname?|null|nullreplyToEmails?array<string>|null|nullnamespaceId?|nullSuccess
application/json- response
id*EmailSenderIdMatch
^sender_[0-9a-hjkmnp-tv-z]{16,24}$email*stringstatus*stringValue in
"pending""verified""failed"providerLifecycle*stringValue in
"provisioning""active""deleting""failed"providerFailureCode*string|nullcreatedAt*stringimport { createClient } from "samva";const samva = createClient({ apiKey: process.env.SAMVA_API_KEY! });const result = await samva.email.addSender({ "email": "example"});Example Response
{ "id": "string", "email": "string", "status": "pending", "providerLifecycle": "provisioning", "providerFailureCode": "string", "createdAt": "string"}