Update a PDF template

Update an existing CWT credential PDF template based on a provided .zip file. Refer to our PDF template design guide for more information on how to design a template and structure the .zip file.

Analytics Events

CREDENTIAL_COMPACT_SEMANTIC_PDF_TEMPLATE_UPDATE_STARTCREDENTIAL_COMPACT_SEMANTIC_PDF_TEMPLATE_UPDATE_SUCCESSCREDENTIAL_COMPACT_SEMANTIC_PDF_TEMPLATE_UPDATE_FAIL

Roles

adminissuer

PUT/v2/credentials/compact-semantic/pdf/templates/{id}

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

idstring

PDF Template ID

idstring

Request Body

bodyfile

Formatbinary

Response Body

curl -X PUT "https://example.vii.au01.mattr.global/v2/credentials/compact-semantic/pdf/templates/string" \
  -H "Content-Type: application/zip" \
  -d 'string'

curl -X PUT "https://example.vii.au01.mattr.global/v2/credentials/compact-semantic/pdf/templates/string" \  -H "Content-Type: application/zip" \  -d 'string'

{
  "id": "4eea7654-d4c5-4eba-bd7a-5ca334d54725",
  "name": "Certificate of participation",
  "fileName": "certificate_of_participation",
  "fonts": [
    {
      "name": "PublicSans-Regular",
      "fileName": "fonts/PublicSans-Regular.ttf"
    }
  ],
  "metadata": {
    "title": ""
  },
  "fields": [
    {
      "key": "familyName",
      "value": "{{payload.sub_claims.familyName}}",
      "isRequired": true,
      "alternativeText": "{{payload.sub_claims.familyName}}",
      "fontName": "PublicSans-Regular"
    }
  ]
}

{
  "code": "string",
  "message": "string",
  "details": [
    {
      "value": "string",
      "msg": "Invalid value",
      "param": "id",
      "location": "body"
    }
  ]
}

{
  "code": "string",
  "message": "string",
  "details": [
    {
      "value": "string",
      "msg": "Invalid value",
      "param": "id",
      "location": "body"
    }
  ]
}