Update an email sender ID

Updates an existing email sender ID using the same inputs as create (domainType managed/byo, plus spoofDomain when managed), re-validating domain spoofability where applicable. Platform library sender IDs can be updated too: the save produces a customised tenant-local copy that overrides the platform profile of the same name — the shared platform original is never modified. Rejects the update if no profile with the given sanitized name exists in either library.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required
string
required
string
string
enum

Primary choice, mirroring the console form. "managed" uses a CanIPhish sending domain — set spoofDomain to say whether you are spoofing a domain; "byo" (bring-your-own) sends from your own domain via your own infrastructure. Takes precedence over profileType when supplied.

Allowed:
boolean

Only used when domainType is "managed": true spoofs the customer's own domain (validated for spoofability via SPF/DMARC), false uses a CanIPhish-managed sending domain.

string

From address. When spoofing (domainType "managed" + spoofDomain true, or profileType "Customer-Managed") the domain is validated for spoofability; for a CanIPhish-managed profile it must be a CanIPhish managed domain; for "byo"/"Customer-Domain" it is your own address.

string
enum

Alternative to domainType (used only when domainType is omitted). "Customer-Domain" = customer-owned SMTP (BYO, no spoof validation); "Customer-Managed" = managed + spoof a customer domain; "CanIPhish-Managed" = managed, use a CanIPhish domain.

Allowed:
Responses

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json