Create an AWS SES credential.
AWS SES credential resource.
AWS SES credential was created.
An existent AWS SES credential was retrieved.
Unauthorized access, invalid credentials were used.
Access forbidden.
Invalid data was sent.
{- "status": "active",
- "key": "BWITYO4UARGDLMFY6UDP",
- "secret": "8D34yYHOK9+yM7pDnNUO3UTO/5b8Wy/PGNyzTRmG",
- "region": "us-west-2",
- "configurationSetName": "SpecialConfigurationSet"
}
{- "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": [
- {
- "rel": "self",
- "href": "string"
}
]
}
Retrieve an AWS SES credential with specified token identifier string.
AWS SES credential was retrieved successfully.
key required | string The AWS access key ID. | ||||
secret required | string The AWS secret access key. | ||||
region required | string The AWS region name. | ||||
hash | string <= 50 characters The resource ID. Defaults to UUID v4. | ||||
status | string The credential status. | ||||
deactivationTime | string <date-time> Read-only timestamp, automatically assigned on back-end. | ||||
configurationSetName | string The configuration set name which will be used durring email sending. | ||||
Array of objects (SelfLink) non-empty The links related to resource. | |||||
Array (non-empty)
|
Unauthorized access, invalid credentials were used.
Access forbidden.
Resource was not found.
const details = await api.credentialHashes.getAWSSESCredential({hash: 'foobar-001'}); console.log(details.fields.configurationSetName);
{- "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": [
- {
- "rel": "self",
- "href": "string"
}
]
}
Update an AWS SES credential with specified token identifier string.
AWS SES credential was updated successfully.
key required | string The AWS access key ID. | ||||
secret required | string The AWS secret access key. | ||||
region required | string The AWS region name. | ||||
hash | string <= 50 characters The resource ID. Defaults to UUID v4. | ||||
status | string The credential status. | ||||
deactivationTime | string <date-time> Read-only timestamp, automatically assigned on back-end. | ||||
configurationSetName | string The configuration set name which will be used durring email sending. | ||||
Array of objects (SelfLink) non-empty The links related to resource. | |||||
Array (non-empty)
|
Unauthorized access, invalid credentials were used.
Access forbidden.
Resource was not found.
Invalid data was sent.
{- "status": "deactivated"
}
{- "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": [
- {
- "rel": "self",
- "href": "string"
}
]
}
Create an email credential.
SMTP credential resource.
SMTP credential was created.
host required | string The host name. | ||||
hash | string <= 50 characters The resource ID. Defaults to UUID v4. | ||||
status | string The credential status. | ||||
deactivationTime | string <date-time> Read-only timestamp, automatically assigned on back-end. | ||||
port | integer [ 1 .. 65535 ] Default: 25 The port value. | ||||
encryption | string Default: "none" The encryption value. | ||||
object (SmtpAuthorization) | |||||
Array of objects (SelfLink) non-empty The links related to resource. | |||||
Array (non-empty)
|
An existent SMTP credential was retrieved.
Unauthorized access, invalid credentials were used.
Access forbidden.
Invalid data was sent.
{- "status": "active",
- "host": "string",
- "port": 25,
- "encryption": "none",
- "auth": {
- "type": "none"
}
}
{- "hash": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
- "status": "active",
- "deactivationTime": "2019-08-24T14:15:22Z",
- "host": "string",
- "port": 25,
- "encryption": "none",
- "auth": {
- "type": "none"
}, - "_links": [
- {
- "rel": "self",
- "href": "string"
}
]
}
Retrieve an email credential with specified token identifier string.
Email credential was retrieved successfully.
host required | string The host name. | ||||
hash | string <= 50 characters The resource ID. Defaults to UUID v4. | ||||
status | string The credential status. | ||||
deactivationTime | string <date-time> Read-only timestamp, automatically assigned on back-end. | ||||
port | integer [ 1 .. 65535 ] Default: 25 The port value. | ||||
encryption | string Default: "none" The encryption value. | ||||
object (SmtpAuthorization) | |||||
Array of objects (SelfLink) non-empty The links related to resource. | |||||
Array (non-empty)
|
Unauthorized access, invalid credentials were used.
Access forbidden.
Resource was not found.
const details = await api.credentialHashes.getEmailCredential({hash: 'foobar-001'}); console.log(details.fields.host);
{- "hash": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
- "status": "active",
- "deactivationTime": "2019-08-24T14:15:22Z",
- "host": "string",
- "port": 25,
- "encryption": "none",
- "auth": {
- "type": "none"
}, - "_links": [
- {
- "rel": "self",
- "href": "string"
}
]
}
Update an email credential with specified token identifier string.
Email credential was updated successfully.
host required | string The host name. | ||||
hash | string <= 50 characters The resource ID. Defaults to UUID v4. | ||||
status | string The credential status. | ||||
deactivationTime | string <date-time> Read-only timestamp, automatically assigned on back-end. | ||||
port | integer [ 1 .. 65535 ] Default: 25 The port value. | ||||
encryption | string Default: "none" The encryption value. | ||||
object (SmtpAuthorization) | |||||
Array of objects (SelfLink) non-empty The links related to resource. | |||||
Array (non-empty)
|
Unauthorized access, invalid credentials were used.
Access forbidden.
Resource was not found.
Invalid data was sent.
{- "status": "deactivated"
}
{- "hash": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
- "status": "active",
- "deactivationTime": "2019-08-24T14:15:22Z",
- "host": "string",
- "port": 25,
- "encryption": "none",
- "auth": {
- "type": "none"
}, - "_links": [
- {
- "rel": "self",
- "href": "string"
}
]
}
Create a mailgun credential.
Mailgun credential was created.
emailFrom required | string <email> The from email address. | ||||
apiKey required | string The mailgun api key. | ||||
domain required | string The mailgun domain. | ||||
hash | string <= 50 characters The resource ID. Defaults to UUID v4. | ||||
status | string The credential status. | ||||
deactivationTime | string <date-time> Read-only timestamp, automatically assigned on back-end. | ||||
Array of objects (SelfLink) non-empty The links related to resource. | |||||
Array (non-empty)
|
An existent Mailgun credential was retrieved.
Unauthorized access, invalid credentials were used.
Access forbidden.
Invalid data was sent.
{- "status": "active",
- "emailFrom": "user@example.com",
- "apiKey": "string",
- "domain": "string"
}
{- "hash": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
- "status": "active",
- "deactivationTime": "2019-08-24T14:15:22Z",
- "emailFrom": "user@example.com",
- "apiKey": "string",
- "domain": "string",
- "_links": [
- {
- "rel": "self",
- "href": "string"
}
]
}
Retrieve a mailgun credential with specified token identifier string.
Mailgun credential was retrieved successfully.
emailFrom required | string <email> The from email address. | ||||
apiKey required | string The mailgun api key. | ||||
domain required | string The mailgun domain. | ||||
hash | string <= 50 characters The resource ID. Defaults to UUID v4. | ||||
status | string The credential status. | ||||
deactivationTime | string <date-time> Read-only timestamp, automatically assigned on back-end. | ||||
Array of objects (SelfLink) non-empty The links related to resource. | |||||
Array (non-empty)
|
Unauthorized access, invalid credentials were used.
Access forbidden.
Resource was not found.
const details = await api.credentialHashes.getMailgunCredential({hash: 'foobar-001'}); console.log(details.fields.domain);
{- "hash": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
- "status": "active",
- "deactivationTime": "2019-08-24T14:15:22Z",
- "emailFrom": "user@example.com",
- "apiKey": "string",
- "domain": "string",
- "_links": [
- {
- "rel": "self",
- "href": "string"
}
]
}
Update a mailgun credential with specified token identifier string.
Mailgun credential was updated successfully.
emailFrom required | string <email> The from email address. | ||||
apiKey required | string The mailgun api key. | ||||
domain required | string The mailgun domain. | ||||
hash | string <= 50 characters The resource ID. Defaults to UUID v4. | ||||
status | string The credential status. | ||||
deactivationTime | string <date-time> Read-only timestamp, automatically assigned on back-end. | ||||
Array of objects (SelfLink) non-empty The links related to resource. | |||||
Array (non-empty)
|
Unauthorized access, invalid credentials were used.
Access forbidden.
Resource was not found.
Invalid data was sent.
{- "status": "deactivated"
}
{- "hash": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
- "status": "active",
- "deactivationTime": "2019-08-24T14:15:22Z",
- "emailFrom": "user@example.com",
- "apiKey": "string",
- "domain": "string",
- "_links": [
- {
- "rel": "self",
- "href": "string"
}
]
}
Create a Postmark credential.
Postmark credential was created.
serverApiToken required | string The Postmark server API token. | ||||
hash | string <= 50 characters The resource ID. Defaults to UUID v4. | ||||
status | string The credential status. | ||||
deactivationTime | string <date-time> Read-only timestamp, automatically assigned on back-end. | ||||
Array of objects (SelfLink) non-empty The links related to resource. | |||||
Array (non-empty)
|
An existent Postmark credential was retrieved.
Unauthorized access, invalid credentials were used.
Access forbidden.
Invalid data was sent.
{- "status": "active",
- "serverApiToken": "dd0508z9-2291-6794-3376-z0a70g12eqm9"
}
{- "hash": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
- "status": "active",
- "deactivationTime": "2019-08-24T14:15:22Z",
- "serverApiToken": "dd0508z9-2291-6794-3376-z0a70g12eqm9",
- "_links": [
- {
- "rel": "self",
- "href": "string"
}
]
}
Retrieve a Postmark credential with specified token identifier string.
Postmark credential was retrieved successfully.
serverApiToken required | string The Postmark server API token. | ||||
hash | string <= 50 characters The resource ID. Defaults to UUID v4. | ||||
status | string The credential status. | ||||
deactivationTime | string <date-time> Read-only timestamp, automatically assigned on back-end. | ||||
Array of objects (SelfLink) non-empty The links related to resource. | |||||
Array (non-empty)
|
Unauthorized access, invalid credentials were used.
Access forbidden.
Resource was not found.
const details = await api.credentialHashes.getPostmarkCredential({hash: 'foobar-001'}); console.log(details.fields.domain);
{- "hash": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
- "status": "active",
- "deactivationTime": "2019-08-24T14:15:22Z",
- "serverApiToken": "dd0508z9-2291-6794-3376-z0a70g12eqm9",
- "_links": [
- {
- "rel": "self",
- "href": "string"
}
]
}
Update a Postmark credential with specified token identifier string.
Postmark credential was updated successfully.
serverApiToken required | string The Postmark server API token. | ||||
hash | string <= 50 characters The resource ID. Defaults to UUID v4. | ||||
status | string The credential status. | ||||
deactivationTime | string <date-time> Read-only timestamp, automatically assigned on back-end. | ||||
Array of objects (SelfLink) non-empty The links related to resource. | |||||
Array (non-empty)
|
Unauthorized access, invalid credentials were used.
Access forbidden.
Resource was not found.
Invalid data was sent.
{- "status": "deactivated"
}
{- "hash": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
- "status": "active",
- "deactivationTime": "2019-08-24T14:15:22Z",
- "serverApiToken": "dd0508z9-2291-6794-3376-z0a70g12eqm9",
- "_links": [
- {
- "rel": "self",
- "href": "string"
}
]
}
Create a SendGrid credential.
SendGrid credential was created.
apiKey required | string The SendGrid api key. | ||||
hash | string <= 50 characters The resource ID. Defaults to UUID v4. | ||||
status | string The credential status. | ||||
deactivationTime | string <date-time> Read-only timestamp, automatically assigned on back-end. | ||||
Array of objects (SelfLink) non-empty The links related to resource. | |||||
Array (non-empty)
|
An existent SendGrid credential was retrieved.
Unauthorized access, invalid credentials were used.
Access forbidden.
Invalid data was sent.
{- "status": "active",
- "apiKey": "SO.WFbRlSWUQJSb40eny4RuZQ.7liHLZ4l1jaPCgbu02b-aGH-bo4RB8z9fK3aUd1heeL"
}
{- "hash": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
- "status": "active",
- "deactivationTime": "2019-08-24T14:15:22Z",
- "apiKey": "SO.WFbRlSWUQJSb40eny4RuZQ.7liHLZ4l1jaPCgbu02b-aGH-bo4RB8z9fK3aUd1heeL",
- "_links": [
- {
- "rel": "self",
- "href": "string"
}
]
}
Retrieve a SendGrid credential with specified token identifier string.
SendGrid credential was retrieved successfully.
apiKey required | string The SendGrid api key. | ||||
hash | string <= 50 characters The resource ID. Defaults to UUID v4. | ||||
status | string The credential status. | ||||
deactivationTime | string <date-time> Read-only timestamp, automatically assigned on back-end. | ||||
Array of objects (SelfLink) non-empty The links related to resource. | |||||
Array (non-empty)
|
Unauthorized access, invalid credentials were used.
Access forbidden.
Resource was not found.
const details = await api.credentialHashes.getSendGridCredential({hash: 'foobar-001'}); console.log(details.fields.apiKey);
{- "hash": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
- "status": "active",
- "deactivationTime": "2019-08-24T14:15:22Z",
- "apiKey": "SO.WFbRlSWUQJSb40eny4RuZQ.7liHLZ4l1jaPCgbu02b-aGH-bo4RB8z9fK3aUd1heeL",
- "_links": [
- {
- "rel": "self",
- "href": "string"
}
]
}
Update a SendGrid credential with specified token identifier string.
SendGrid credential was updated successfully.
apiKey required | string The SendGrid api key. | ||||
hash | string <= 50 characters The resource ID. Defaults to UUID v4. | ||||
status | string The credential status. | ||||
deactivationTime | string <date-time> Read-only timestamp, automatically assigned on back-end. | ||||
Array of objects (SelfLink) non-empty The links related to resource. | |||||
Array (non-empty)
|
Unauthorized access, invalid credentials were used.
Access forbidden.
Resource was not found.
Invalid data was sent.
{- "status": "deactivated"
}
{- "hash": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
- "status": "active",
- "deactivationTime": "2019-08-24T14:15:22Z",
- "apiKey": "SO.WFbRlSWUQJSb40eny4RuZQ.7liHLZ4l1jaPCgbu02b-aGH-bo4RB8z9fK3aUd1heeL",
- "_links": [
- {
- "rel": "self",
- "href": "string"
}
]
}