Mail

Create queue jobs to send emails using templates.

post

Claim-based access control: Issuer_Admin

Authorizations

x-api-keybearer

Body

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

HTTPcURLJavaScriptPython

POST /products/web/$IDENTITY_ENV_ID/portalbackend/api/api/v1/mail HTTP/1.1
Host: identity.nchainplatform.com
X-API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 176

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

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