Skip to main content
POST
/
service-of-notice
/
attachments
/
create
Generate a service-of-notice attachment
curl --request POST \
  --url https://api.platform.arb.inc/service-of-notice/attachments/create \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "mailType": "pressureSealed",
  "url": "https://www.example.com/notice-image"
}
'
"<string>"

Authorizations

​
Authorization
string
header
required

access token

Body

application/json
​
mailType
string
required

The mail type identifier. Must support attachments.

Example:

"pressureSealed"

​
url
string
required

URL of the webpage to screenshot. The page will be captured and returned as a PNG image sized to fit the attachment area of the specified mail type.

Maximum string length: 500
Example:

"https://www.example.com/notice-image"

Response

Screenshot captured successfully. Returns raw PNG image data.

The response is of type file.