Add a new API key

post https://api.smtp2go.com/v3/api_keys/add

Add a new API key to your account
This endpoint is rate-limited to 5 requests per minute.

Body Params

description

string

A comment or description of your new API key

custom_ratelimit

boolean

If true, a custom rate limit will be enabled for this user, and defined by the custom_ratelimit_value and custom_ratelimit_period.

custom_ratelimit_value

integer

If passed, defines the limit of emails this user can send in the period specified in custom_ratelimit_period.

Note: Only stores this value if custom_ratelimit is true.

custom_ratelimit_period

string

If passed, defines the period for which this user will be limited to the number of emails specified in custom_ratelimit_value.

Syntax: "<n> [hour[s]|day[s]|week[s]|month[s]] [hh:mm:ss]".

Examples: "0:30:00", "1 hour", "2 days", "3 months", "4 months 5:00:00".

Note: Only stores this value if custom_ratelimit is true.

ip_pool

integer

If passed, any emails sent with this API key will use dedicated IP's in this IP Pool, This value can be found on the /v3/dedicated_ips/view endpoint.

feedback_enabled

boolean

Defaults to false

If true, custom feedback via the unsubscribe footer will be enabled and defined by the below settings.

feedback_html

string

The HTML content to insert into the custom feedback email body via the unsubscribe footer.

System Variables (Only available here):

Unsubscribe URL = %%UNSUBSCRIBE%%
Email address = %%EMAIL%%

feedback_text

string

The text content to insert into the custom feedback email body via the unsubscribe footer.

System Variables (Only available here):

Unsubscribe URL = %%UNSUBSCRIBE%%
Email address = %%EMAIL%%

open_tracking_enabled

boolean

Defaults to false

If true, open tracking will be enabled for this API key.

click_tracking_enabled

boolean

Defaults to false

If true, click tracking will be enabled for this API key.

archive_enabled

boolean

Defaults to false

If true, archiving (available on paid plans) will be enabled for this API key.

audit_email

string

If passed, this email will be BCC'd on all emails sent by this API key.

bounce_notifications

string

Defaults to from

If passed, will control how bounce notifications are handled. Must be one of [from, drop, or a valid email address]. [from] will return the email to sender, [drop] will discard the event, and the inclusion of an email address will send the event on to this account.

status

string

Defaults to allowed

The initial status of the API key, one of ['allowed', 'blocked', 'sandbox'].

endpoints

array of strings

Defaults to /email/send

An array of endpoints that this API key will be allowed to use.

A full list of endpoints can be found in the app under Sending->API Keys->Permissions or programatically via the API here.

We also accept wildcard patterns, for example to allow access to all email endpoints you can pass ["/email/*"].

To allow access to every endpoint simply pass "endpoints": ["*"]

endpoints

subaccount_id

string

If you wish to make this API call on behalf of a subaccount then include its unique ID here.

xxxxxxxxxx
curl --request POST \
     --url https://api.smtp2go.com/v3/api_keys/add \
     --header 'Content-Type: application/json' \
     --header 'accept: application/json' \
     --data '
{
  "feedback_enabled": false,
  "open_tracking_enabled": false,
  "click_tracking_enabled": false,
  "archive_enabled": false,
  "bounce_notifications": "from",
  "status": "allowed",
  "endpoints": [
    "/email/send"
  ]
}
'

200Successfully added API key

400400