Create an email sender ID

post

https://api.caniphish.com/api/v3/content-library/sender-ids/create-sender-id

Creates a new email sender ID (sender profile). Mirrors the console form: choose domainType "managed" (then set spoofDomain to say whether you're spoofing a domain — spoofed domains are validated for spoofability) or "byo" to send from your own domain. Rejects names already used by a custom sender ID or a platform library sender ID — to customise a platform sender ID use update-sender-id, or copy it under a new name with duplicate-sender-id.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

tenantID

string

required

profileName

string

required

displayName

string

domainType

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:

spoofDomain

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.

sendingAddress

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.

profileType

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

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Created

400Error