Skip to content
Athena User Guide
Esc
↑↓navigate↵open⌘Jpreview

Save a certificate template's draft layout

PUT/api/admin/certificates/templates/{id}/draft
Path parameters
idstringrequired
min length 1
Request body
requiredapplication/json
specobjectrequired
Show properties
specVersionnumberrequired
pageSizestringrequired
Allowed:a4_landscapea4_portraitletter_landscape
sizeobjectrequired
Show properties
wnumberrequired
hnumberrequired
backgroundobject | nullrequired
Show properties
Any of:
object
fileIdstringrequired
min length 1
contentTypestringrequired
Allowed:image/pngimage/jpeg
widthintegerrequired
max 9007199254740991
heightintegerrequired
max 9007199254740991
byteSizeintegerrequired
max 9007199254740991
null
null
elementsobject[]required
Show properties
Array of object
One of:
object
idstringrequired
min length 1
typestringrequired
valuestringrequired
fontstringrequired
Allowed:inter-regularinter-boldplayfair-boldjetbrains-mono
sizenumberrequired
min 4 · max 240
xnumberrequired
ynumberrequired
alignstringrequired
Allowed:leftcenterright
colorstringrequired
matches ^#[0-9a-fA-F]{6}$
autoFitbooleanrequired
maxWidthnumberrequired
object
idstringrequired
min length 1
typestringrequired
sizenumberrequired
min 99 · max 283
xnumberrequired
ynumberrequired
alignstringrequired
Allowed:leftcenterright
colorstringrequired
matches ^#[0-9a-fA-F]{6}$
backgroundstringrequired
matches ^#[0-9a-fA-F]{6}$
Responses
200

Success

successbooleanrequired
401

Unauthorized

errorstringrequired
404

Not found

errorstringrequired
422

Validation failed

typestringrequired
onstringrequired
summarystring
messagestring
foundany
propertystring
expectedstring
500

Unhandled server error

errorstringrequired
Try it
Server
Parameters
Bodyapplication/json
Request
curl -X PUT '/api/admin/certificates/templates/string/draft' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "spec": {
    "specVersion": 1,
    "pageSize": "a4_landscape",
    "size": {
      "w": 1,
      "h": 1
    },
    "background": {
      "fileId": "string",
      "contentType": "image/png",
      "width": 1,
      "height": 1,
      "byteSize": 1
    },
    "elements": [
      {
        "id": "string",
        "type": "text",
        "value": "string",
        "font": "inter-regular",
        "size": 4,
        "x": 0,
        "y": 0,
        "align": "left",
        "color": "string",
        "autoFit": true,
        "maxWidth": 1
      }
    ]
  }
}'
Response
{
  "success": true
}