API Key Configuration

Use the resources below to manage your API Keys, as well as the access rights assigned to other users.

post

Create a new sub-account API Key

post

/apikey

Create a sub-account with a new Public and Secret API Key. API Keys are used as credentials to access the API and SMTP server.

Full API path

https://api.mailjet.com/v3/REST/apikey

Body parameters

ACL

string

Access Control List. Indicates permissions attached to a resource.

IsActive

boolean

Indicates whether this API Key is active or not.

Name

string, required

User readable name for this API Key.

Responses

Note: You can find all the errors related to API in the error page

Count

integer

Data

array

ACL

string

Access Control List. Indicates permissions attached to a resource.

IsActive

boolean

Indicates whether this API Key is active or not.

APIKey

string

The unique alphanumeric API Key itself.

CreatedAt

string

Timestamp indicating when the API Key was created.

ID

integer

Unique numeric ID for this API Key.

IsMaster

boolean

Indicates whether this is the Master API Key or not.

Name

string

Unique user-selected name for this API Key.

QuarantineValue

integer

Indicates the sending limitation applied on this API Key in terms of messages per hour, when the API Key is under quarantine. 0 means no limitation is applied.

Runlevel

object

Runlevel, used to indicate data is migrated and reduced performance is expected..

Possible values:

  • Normal
  • Softlock
  • Hardlock

Default value: Normal

SecretKey

string

The unique alphanumeric Secret Key (password) linked to this API Key.

Skipspamd

boolean

Deprecated property.

TrackHost

string

Host to be used when tracking clicks, opens, unsubscribe requests for this API Key.

Default value: r.mailjet.com

UserID

integer

User ID. The Master API Key and all sub-account API Keys will have the same user ID.

Total

integer