ELelasticemail
Security

Add ApiKey

Add a new ApiKey. Required Access Level: ModifyAccessTokens

post/security/apikeys

Request

  • Base URL
    https://api.elasticemail.com/v4
  • URL
    https://api.elasticemail.com/v4/security/apikeys
  • Auth
    API key in header X-ElasticEmail-ApiKey

Request body

Namestring string required

Name of the ApiKey for ease of reference.

AccessLevelAccessLevel[] required

Access level or permission to be assigned to this ApiKey.

Expiresstring date-time nullable

Date this ApiKey expires.

RestrictAccessToIPRangestring[]

Which IPs can use this ApiKey

Subaccountstring string

Email of the subaccount for which this ApiKey should be created

Response

Created

Tokenstring string

Unique token to be used in the system

AccessLevelAccessLevel[]

Access level or permission to be assigned to this ApiKey.

Namestring string

Name of the ApiKey.

DateCreatedstring date-time

Date this ApiKey was created.

LastUsestring date-time nullable

Date this ApiKey was last used.

Expiresstring date-time nullable

Date this ApiKey expires.

RestrictAccessToIPRangestring[]

Which IPs can use this ApiKey

Changes

No recorded changes to this operation across all 2 revisions of this API.