Mail

Send a test email to the provided email address.

post

Claim-based access control: Issuer_Admin

Authorizations

bearer

Body

application/json

namestringRequired

Responses

201Success

application/json

400

Invalid request body.

401

Invalid authentication credentials.

403

User does not have a required claim to perform this operation.

503

Error sending email.

post

/api/v1/dev/mail/test-email

HTTPcURLJavaScriptPython

POST /api/v1/dev/mail/test-email HTTP/1.1
Host: {PORTAL_API_BASE_URL}
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 38

{
  "recipientEmails": [
    []
  ],
  "name": "text"
}

{
  "message": "text",
  "scheduledJobIds": [
    []
  ]
}

Create queue jobs to send emails using templates.

post

Claim-based access control: Identity_Issuer_Api

Authorizations

bearer

Body

application/json

Responses

201

Email is queued

application/json

400

Invalid request body.

401

Invalid authentication credentials.

403

User does not have a required claim to perform this operation.

503

Error sending email.

post

/api/v1/mail

HTTPcURLJavaScriptPython

POST /api/v1/mail HTTP/1.1
Host: {PORTAL_API_BASE_URL}
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 203

{
  "email": [
    {
      "recipientEmails": [
        []
      ],
      "templateName": "CredentialShare",
      "templateData": {
        "organisationProfileId": "text",
        "issuerCredentialNames": "text",
        "credentialPageLink": "text",
        "magicLinkRawToken": "text"
      }
    }
  ]
}

{
  "message": "text",
  "scheduledJobIds": [
    []
  ]
}