Create sender profile

If you have questions regarding this API, please visit our API FAQ page.

Creating a sender profile

Make a POST request to https://webapi.inboxroad.com/api/v2/sender-profiles/ with a valid X-API-Key (see v2 authentication).

curl -X POST 'https://webapi.inboxroad.com/api/v2/sender-profiles/' \
  -H 'X-API-Key: <your_token>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "Acme Newsletter",
    "email": "news@acme.com",
    "reply_to": "support@acme.com"
  }'

By default the profile sends through Inboxroad’s infrastructure. To send through your own relay instead, include an external_smtp object — this is available to Email Pro customers only; other accounts receive 403.

Request fields

Field name	Required	Description
name	Yes	Human-readable sender name (max 255 chars, cannot be blank).
email	Yes	From address. Its domain determines the sending domain.
reply_to	No	Reply-To address.
external_smtp	No	Custom SMTP relay. Email Pro customers only (see fields below).

External SMTP fields (external_smtp)

Field name	Required	Description
host	Yes	SMTP host.
port	Yes	SMTP port.
username	Yes	SMTP username.
password	Yes	SMTP password. Never returned in responses.
provider	No	One of sendgrid, mailgun, amazon_ses, sparkpost, postmark, smtp2go, mailjet, mandrill, brevo, mysmtp, smtpcom, other. Default other.
smtp_name	No	Human-readable label for the relay.
security	No	Transport security: none, tls, or ssl. Default tls.
bounce_webhook_url	No	URL the provider posts bounce notifications to.
bounce_email_address	No	Address that receives bounce notifications.

Response

On success the API returns 201 with the created sender profile. See List sender profiles for the object shape.

Possible response codes

Status code	Description
201	Sender profile created successfully.
401	Unauthorized.
403	external_smtp supplied but the account is not Email Pro. Body: { "errors": [ ... ] }.