List sender profiles

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

A sender profile is a reusable From identity (name, From address and optional Reply-To). Its id is what you pass as welcome_sender_profile_id when creating or updating a contacts list.

The sending domain is resolved from the profile’s email. Deliverability still depends on that domain being verified — always check is_domain_verified before relying on a profile for sending.

Listing sender profiles

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

curl -X GET 'https://webapi.inboxroad.com/api/v2/sender-profiles/' \
  -H 'X-API-Key: <your_token>' \
  -H 'Content-Type: application/json'

Returns 200 with an array of sender profile objects (not paginated).

Query parameters

Param name	Possible values	Description
ordering	asc, desc	Sort direction. Default desc.
order_by	name, email, reply_to, smtp_name, created_at	Field to sort by. Default created_at.

Sender profile object

Field name	Description
id	Unique identifier of the sender profile (UUID).
name	Human-readable sender name.
email	From address. Its domain determines the sending domain.
reply_to	Reply-To address, or null.
external_smtp	Custom SMTP relay configuration, or null (see below).
is_domain_verified	Whether the sending domain is verified. Sends are only reliable when true.

External SMTP object (external_smtp)

Present only for profiles that send through a customer-supplied relay. The password is never returned.

Field name	Description
id	Unique identifier of the SMTP configuration (UUID).
provider	SMTP provider key (see allowed values below).
smtp_name	Human-readable label for the relay.
host	SMTP host.
port	SMTP port.
username	SMTP username.
security	Transport security: none, tls, or ssl.
bounce_webhook_url	URL the provider posts bounce notifications to.
bounce_email_address	Address that receives bounce notifications.

Example response

[
  {
    "id": "2b9a1c44-7f3e-4d21-9a0b-1c2d3e4f5a6b",
    "name": "Acme Newsletter",
    "email": "news@acme.com",
    "reply_to": "support@acme.com",
    "external_smtp": null,
    "is_domain_verified": true
  }
]

Possible response codes

Status code	Description
200	Sender profiles retrieved successfully.
401	Unauthorized.