Skip to main content
POST
/
service-of-notice
/
mail-types
/
list
Get available mail types
curl --request POST \
  --url https://cases.platform.arb.inc/service-of-notice/mail-types/list \
  --header 'Authorization: Bearer <token>'
{
  "mailTypes": [
    {
      "id": "sealedMailer",
      "displayName": "Sealed Mailer",
      "description": "A folded and sealed letter with optional image attachment.",
      "inputType": "files",
      "UserFields": [
        {
          "id": "attachment",
          "displayName": "Custom Image",
          "description": "Optional image to include in the mailing.",
          "pixelWidth": 1000,
          "pixelHeight": 600
        }
      ]
    },
    {
      "id": "customNotice",
      "displayName": "Custom Notice Template",
      "description": "HTML template with dynamic content fields",
      "inputType": "json",
      "UserFields": []
    }
  ]
}

Authorizations

Authorization
string
header
required

access token

Response

200 - application/json

Mail types successfully retrieved.

mailTypes
object[]

List of available mail types.