logo

Email Credentials

Get and create SMTP credential hashes.

Create an AWS SES credential

Create an AWS SES credential.

Request
Security:
SecretApiKey or JWT
header Parameters
Organization-Id
string (ResourceId) <= 50 characters
Deprecated

Organization identifier in scope of which need to perform request (if not specified, the default organization will be used).

It is deprecated. Use servers with /organizations/{organizationId} base path instead.

Example: 4f6cf35x-2c4y-483z-a0a9-158621f77a21
Request Body schema: application/json

AWS SES credential resource.

status
string

The credential status.

Enum: "active" "deactivated"
key
required
string

The AWS access key ID.

secret
required
string

The AWS secret access key.

region
required
string

The AWS region name.

configurationSetName
string

The configuration set name which will be used durring email sending.

Responses
201

AWS SES credential was created.

303

An existent AWS SES credential was retrieved.

401

Unauthorized access, invalid credentials were used.

403

Access forbidden.

422

Invalid data was sent.

post/credential-hashes/aws-ses
Request samples
    3 more
    Java
    Go
    Ruby
application/json
{
  • "status": "active",
  • "key": "BWITYO4UARGDLMFY6UDP",
  • "secret": "8D34yYHOK9+yM7pDnNUO3UTO/5b8Wy/PGNyzTRmG",
  • "region": "us-west-2",
  • "configurationSetName": "SpecialConfigurationSet"
}
Response samples
application/json
{
  • "hash": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
  • "status": "active",
  • "deactivationTime": "2019-08-24T14:15:22Z",
  • "key": "BWITYO4UARGDLMFY6UDP",
  • "secret": "8D34yYHOK9+yM7pDnNUO3UTO/5b8Wy/PGNyzTRmG",
  • "region": "us-west-2",
  • "configurationSetName": "SpecialConfigurationSet",
  • "_links": [
    ]
}

Retrieve an AWS SES credential

Retrieve an AWS SES credential with specified token identifier string.

Request
Security:
SecretApiKey or JWT
path Parameters
hash
required
string

The token identifier string.

header Parameters
Organization-Id
string (ResourceId) <= 50 characters
Deprecated

Organization identifier in scope of which need to perform request (if not specified, the default organization will be used).

It is deprecated. Use servers with /organizations/{organizationId} base path instead.

Example: 4f6cf35x-2c4y-483z-a0a9-158621f77a21
Responses
200

AWS SES credential was retrieved successfully.

401

Unauthorized access, invalid credentials were used.

403

Access forbidden.

404

Resource was not found.

get/credential-hashes/aws-ses/{hash}
Request samples
    3 more
    Java
    Go
    Ruby
const details = await api.credentialHashes.getAWSSESCredential({hash: 'foobar-001'});
console.log(details.fields.configurationSetName);
Response samples
application/json
{
  • "hash": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
  • "status": "active",
  • "deactivationTime": "2019-08-24T14:15:22Z",
  • "key": "BWITYO4UARGDLMFY6UDP",
  • "secret": "8D34yYHOK9+yM7pDnNUO3UTO/5b8Wy/PGNyzTRmG",
  • "region": "us-west-2",
  • "configurationSetName": "SpecialConfigurationSet",
  • "_links": [
    ]
}

Update an AWS SES credential

Update an AWS SES credential with specified token identifier string.

Request
Security:
SecretApiKey or JWT
path Parameters
hash
required
string

The token identifier string.

header Parameters
Organization-Id
string (ResourceId) <= 50 characters
Deprecated

Organization identifier in scope of which need to perform request (if not specified, the default organization will be used).

It is deprecated. Use servers with /organizations/{organizationId} base path instead.

Example: 4f6cf35x-2c4y-483z-a0a9-158621f77a21
Request Body schema: application/json

AWS SES credential resource.

status
required
string

The credential status.

Value: "deactivated"
Responses
200

AWS SES credential was updated successfully.

401

Unauthorized access, invalid credentials were used.

403

Access forbidden.

404

Resource was not found.

422

Invalid data was sent.

patch/credential-hashes/aws-ses/{hash}
Request samples
    3 more
    Java
    Go
    Ruby
application/json
{
  • "status": "deactivated"
}
Response samples
application/json
{
  • "hash": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
  • "status": "active",
  • "deactivationTime": "2019-08-24T14:15:22Z",
  • "key": "BWITYO4UARGDLMFY6UDP",
  • "secret": "8D34yYHOK9+yM7pDnNUO3UTO/5b8Wy/PGNyzTRmG",
  • "region": "us-west-2",
  • "configurationSetName": "SpecialConfigurationSet",
  • "_links": [
    ]
}

Create an email credential

Create an email credential.

Request
Security:
SecretApiKey or JWT
header Parameters
Organization-Id
string (ResourceId) <= 50 characters
Deprecated

Organization identifier in scope of which need to perform request (if not specified, the default organization will be used).

It is deprecated. Use servers with /organizations/{organizationId} base path instead.

Example: 4f6cf35x-2c4y-483z-a0a9-158621f77a21
Request Body schema: application/json

SMTP credential resource.

status
string

The credential status.

Enum: "active" "deactivated"
host
required
string

The host name.

port
integer [ 1 .. 65535 ]
Default: 25

The port value.

encryption
string
Default: "none"

The encryption value.

Enum: "none" "tls" "ssl"
object (SmtpAuthorization)
type
string
Default: "none"
none
none
plain
login
cram-md5
Responses
201

SMTP credential was created.

303

An existent SMTP credential was retrieved.

401

Unauthorized access, invalid credentials were used.

403

Access forbidden.

422

Invalid data was sent.

post/credential-hashes/emails
Request samples
    3 more
    Java
    Go
    Ruby
application/json
{
  • "status": "active",
  • "host": "string",
  • "port": 25,
  • "encryption": "none",
  • "auth": {
    }
}
Response samples
application/json
{
  • "hash": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
  • "status": "active",
  • "deactivationTime": "2019-08-24T14:15:22Z",
  • "host": "string",
  • "port": 25,
  • "encryption": "none",
  • "auth": {
    },
  • "_links": [
    ]
}

Retrieve an email credential

Retrieve an email credential with specified token identifier string.

Request
Security:
SecretApiKey or JWT
path Parameters
hash
required
string

The token identifier string.

header Parameters
Organization-Id
string (ResourceId) <= 50 characters
Deprecated

Organization identifier in scope of which need to perform request (if not specified, the default organization will be used).

It is deprecated. Use servers with /organizations/{organizationId} base path instead.

Example: 4f6cf35x-2c4y-483z-a0a9-158621f77a21
Responses
200

Email credential was retrieved successfully.

401

Unauthorized access, invalid credentials were used.

403

Access forbidden.

404

Resource was not found.

get/credential-hashes/emails/{hash}
Request samples
    3 more
    Java
    Go
    Ruby
const details = await api.credentialHashes.getEmailCredential({hash: 'foobar-001'});
console.log(details.fields.host);
Response samples
application/json
{
  • "hash": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
  • "status": "active",
  • "deactivationTime": "2019-08-24T14:15:22Z",
  • "host": "string",
  • "port": 25,
  • "encryption": "none",
  • "auth": {
    },
  • "_links": [
    ]
}

Update an email credential

Update an email credential with specified token identifier string.

Request
Security:
SecretApiKey or JWT
path Parameters
hash
required
string

The token identifier string.

header Parameters
Organization-Id
string (ResourceId) <= 50 characters
Deprecated

Organization identifier in scope of which need to perform request (if not specified, the default organization will be used).

It is deprecated. Use servers with /organizations/{organizationId} base path instead.

Example: 4f6cf35x-2c4y-483z-a0a9-158621f77a21
Request Body schema: application/json

Email credential resource.

status
required
string

The credential status.

Value: "deactivated"
Responses
200

Email credential was updated successfully.

401

Unauthorized access, invalid credentials were used.

403

Access forbidden.

404

Resource was not found.

422

Invalid data was sent.

patch/credential-hashes/emails/{hash}
Request samples
    3 more
    Java
    Go
    Ruby
application/json
{
  • "status": "deactivated"
}
Response samples
application/json
{
  • "hash": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
  • "status": "active",
  • "deactivationTime": "2019-08-24T14:15:22Z",
  • "host": "string",
  • "port": 25,
  • "encryption": "none",
  • "auth": {
    },
  • "_links": [
    ]
}

Create a mailgun credential

Create a mailgun credential.

Request
Security:
SecretApiKey or JWT
header Parameters
Organization-Id
string (ResourceId) <= 50 characters
Deprecated

Organization identifier in scope of which need to perform request (if not specified, the default organization will be used).

It is deprecated. Use servers with /organizations/{organizationId} base path instead.

Example: 4f6cf35x-2c4y-483z-a0a9-158621f77a21
Request Body schema: application/json

Mailgun credential resource.

status
string

The credential status.

Enum: "active" "deactivated"
emailFrom
required
string <email>

The from email address.

apiKey
required
string

The mailgun api key.

domain
required
string

The mailgun domain.

Responses
201

Mailgun credential was created.

303

An existent Mailgun credential was retrieved.

401

Unauthorized access, invalid credentials were used.

403

Access forbidden.

422

Invalid data was sent.

post/credential-hashes/mailgun
Request samples
    3 more
    Java
    Go
    Ruby
application/json
{
  • "status": "active",
  • "emailFrom": "user@example.com",
  • "apiKey": "string",
  • "domain": "string"
}
Response samples
application/json
{
  • "hash": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
  • "status": "active",
  • "deactivationTime": "2019-08-24T14:15:22Z",
  • "emailFrom": "user@example.com",
  • "apiKey": "string",
  • "domain": "string",
  • "_links": [
    ]
}

Retrieve a mailgun credential

Retrieve a mailgun credential with specified token identifier string.

Request
Security:
SecretApiKey or JWT
path Parameters
hash
required
string

The token identifier string.

header Parameters
Organization-Id
string (ResourceId) <= 50 characters
Deprecated

Organization identifier in scope of which need to perform request (if not specified, the default organization will be used).

It is deprecated. Use servers with /organizations/{organizationId} base path instead.

Example: 4f6cf35x-2c4y-483z-a0a9-158621f77a21
Responses
200

Mailgun credential was retrieved successfully.

401

Unauthorized access, invalid credentials were used.

403

Access forbidden.

404

Resource was not found.

get/credential-hashes/mailgun/{hash}
Request samples
    3 more
    Java
    Go
    Ruby
const details = await api.credentialHashes.getMailgunCredential({hash: 'foobar-001'});
console.log(details.fields.domain);
Response samples
application/json
{
  • "hash": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
  • "status": "active",
  • "deactivationTime": "2019-08-24T14:15:22Z",
  • "emailFrom": "user@example.com",
  • "apiKey": "string",
  • "domain": "string",
  • "_links": [
    ]
}

Update a mailgun credential

Update a mailgun credential with specified token identifier string.

Request
Security:
SecretApiKey or JWT
path Parameters
hash
required
string

The token identifier string.

header Parameters
Organization-Id
string (ResourceId) <= 50 characters
Deprecated

Organization identifier in scope of which need to perform request (if not specified, the default organization will be used).

It is deprecated. Use servers with /organizations/{organizationId} base path instead.

Example: 4f6cf35x-2c4y-483z-a0a9-158621f77a21
Request Body schema: application/json

Mailgun credential resource.

status
required
string

The credential status.

Value: "deactivated"
Responses
200

Mailgun credential was updated successfully.

401

Unauthorized access, invalid credentials were used.

403

Access forbidden.

404

Resource was not found.

422

Invalid data was sent.

patch/credential-hashes/mailgun/{hash}
Request samples
    3 more
    Java
    Go
    Ruby
application/json
{
  • "status": "deactivated"
}
Response samples
application/json
{
  • "hash": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
  • "status": "active",
  • "deactivationTime": "2019-08-24T14:15:22Z",
  • "emailFrom": "user@example.com",
  • "apiKey": "string",
  • "domain": "string",
  • "_links": [
    ]
}

Create a Postmark credential

Create a Postmark credential.

Request
Security:
SecretApiKey or JWT
header Parameters
Organization-Id
string (ResourceId) <= 50 characters
Deprecated

Organization identifier in scope of which need to perform request (if not specified, the default organization will be used).

It is deprecated. Use servers with /organizations/{organizationId} base path instead.

Example: 4f6cf35x-2c4y-483z-a0a9-158621f77a21
Request Body schema: application/json

Postmark credential resource.

status
string

The credential status.

Enum: "active" "deactivated"
serverApiToken
required
string

The Postmark server API token.

Responses
201

Postmark credential was created.

303

An existent Postmark credential was retrieved.

401

Unauthorized access, invalid credentials were used.

403

Access forbidden.

422

Invalid data was sent.

post/credential-hashes/postmark
Request samples
    3 more
    Java
    Go
    Ruby
application/json
{
  • "status": "active",
  • "serverApiToken": "dd0508z9-2291-6794-3376-z0a70g12eqm9"
}
Response samples
application/json
{
  • "hash": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
  • "status": "active",
  • "deactivationTime": "2019-08-24T14:15:22Z",
  • "serverApiToken": "dd0508z9-2291-6794-3376-z0a70g12eqm9",
  • "_links": [
    ]
}

Retrieve a Postmark credential

Retrieve a Postmark credential with specified token identifier string.

Request
Security:
SecretApiKey or JWT
path Parameters
hash
required
string

The token identifier string.

header Parameters
Organization-Id
string (ResourceId) <= 50 characters
Deprecated

Organization identifier in scope of which need to perform request (if not specified, the default organization will be used).

It is deprecated. Use servers with /organizations/{organizationId} base path instead.

Example: 4f6cf35x-2c4y-483z-a0a9-158621f77a21
Responses
200

Postmark credential was retrieved successfully.

401

Unauthorized access, invalid credentials were used.

403

Access forbidden.

404

Resource was not found.

get/credential-hashes/postmark/{hash}
Request samples
    3 more
    Java
    Go
    Ruby
const details = await api.credentialHashes.getPostmarkCredential({hash: 'foobar-001'});
console.log(details.fields.domain);
Response samples
application/json
{
  • "hash": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
  • "status": "active",
  • "deactivationTime": "2019-08-24T14:15:22Z",
  • "serverApiToken": "dd0508z9-2291-6794-3376-z0a70g12eqm9",
  • "_links": [
    ]
}

Update a Postmark credential

Update a Postmark credential with specified token identifier string.

Request
Security:
SecretApiKey or JWT
path Parameters
hash
required
string

The token identifier string.

header Parameters
Organization-Id
string (ResourceId) <= 50 characters
Deprecated

Organization identifier in scope of which need to perform request (if not specified, the default organization will be used).

It is deprecated. Use servers with /organizations/{organizationId} base path instead.

Example: 4f6cf35x-2c4y-483z-a0a9-158621f77a21
Request Body schema: application/json

Postmark credential resource.

status
required
string

The credential status.

Value: "deactivated"
Responses
200

Postmark credential was updated successfully.

401

Unauthorized access, invalid credentials were used.

403

Access forbidden.

404

Resource was not found.

422

Invalid data was sent.

patch/credential-hashes/postmark/{hash}
Request samples
    3 more
    Java
    Go
    Ruby
application/json
{
  • "status": "deactivated"
}
Response samples
application/json
{
  • "hash": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
  • "status": "active",
  • "deactivationTime": "2019-08-24T14:15:22Z",
  • "serverApiToken": "dd0508z9-2291-6794-3376-z0a70g12eqm9",
  • "_links": [
    ]
}

Create a SendGrid credential

Create a SendGrid credential.

Request
Security:
SecretApiKey or JWT
header Parameters
Organization-Id
string (ResourceId) <= 50 characters
Deprecated

Organization identifier in scope of which need to perform request (if not specified, the default organization will be used).

It is deprecated. Use servers with /organizations/{organizationId} base path instead.

Example: 4f6cf35x-2c4y-483z-a0a9-158621f77a21
Request Body schema: application/json

SendGrid credential resource.

status
string

The credential status.

Enum: "active" "deactivated"
apiKey
required
string

The SendGrid api key.

Responses
201

SendGrid credential was created.

303

An existent SendGrid credential was retrieved.

401

Unauthorized access, invalid credentials were used.

403

Access forbidden.

422

Invalid data was sent.

post/credential-hashes/sendgrid
Request samples
    3 more
    Java
    Go
    Ruby
application/json
{
  • "status": "active",
  • "apiKey": "SO.WFbRlSWUQJSb40eny4RuZQ.7liHLZ4l1jaPCgbu02b-aGH-bo4RB8z9fK3aUd1heeL"
}
Response samples
application/json
{
  • "hash": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
  • "status": "active",
  • "deactivationTime": "2019-08-24T14:15:22Z",
  • "apiKey": "SO.WFbRlSWUQJSb40eny4RuZQ.7liHLZ4l1jaPCgbu02b-aGH-bo4RB8z9fK3aUd1heeL",
  • "_links": [
    ]
}

Retrieve a SendGrid credential

Retrieve a SendGrid credential with specified token identifier string.

Request
Security:
SecretApiKey or JWT
path Parameters
hash
required
string

The token identifier string.

header Parameters
Organization-Id
string (ResourceId) <= 50 characters
Deprecated

Organization identifier in scope of which need to perform request (if not specified, the default organization will be used).

It is deprecated. Use servers with /organizations/{organizationId} base path instead.

Example: 4f6cf35x-2c4y-483z-a0a9-158621f77a21
Responses
200

SendGrid credential was retrieved successfully.

401

Unauthorized access, invalid credentials were used.

403

Access forbidden.

404

Resource was not found.

get/credential-hashes/sendgrid/{hash}
Request samples
    3 more
    Java
    Go
    Ruby
const details = await api.credentialHashes.getSendGridCredential({hash: 'foobar-001'});
console.log(details.fields.apiKey);
Response samples
application/json
{
  • "hash": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
  • "status": "active",
  • "deactivationTime": "2019-08-24T14:15:22Z",
  • "apiKey": "SO.WFbRlSWUQJSb40eny4RuZQ.7liHLZ4l1jaPCgbu02b-aGH-bo4RB8z9fK3aUd1heeL",
  • "_links": [
    ]
}

Update a SendGrid credential

Update a SendGrid credential with specified token identifier string.

Request
Security:
SecretApiKey or JWT
path Parameters
hash
required
string

The token identifier string.

header Parameters
Organization-Id
string (ResourceId) <= 50 characters
Deprecated

Organization identifier in scope of which need to perform request (if not specified, the default organization will be used).

It is deprecated. Use servers with /organizations/{organizationId} base path instead.

Example: 4f6cf35x-2c4y-483z-a0a9-158621f77a21
Request Body schema: application/json

SendGrid credential resource.

status
required
string

The credential status.

Value: "deactivated"
Responses
200

SendGrid credential was updated successfully.

401

Unauthorized access, invalid credentials were used.

403

Access forbidden.

404

Resource was not found.

422

Invalid data was sent.

patch/credential-hashes/sendgrid/{hash}
Request samples
    3 more
    Java
    Go
    Ruby
application/json
{
  • "status": "deactivated"
}
Response samples
application/json
{
  • "hash": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
  • "status": "active",
  • "deactivationTime": "2019-08-24T14:15:22Z",
  • "apiKey": "SO.WFbRlSWUQJSb40eny4RuZQ.7liHLZ4l1jaPCgbu02b-aGH-bo4RB8z9fK3aUd1heeL",
  • "_links": [
    ]
}
➔ Next to Email Delivery Settings