Render Agreement Template

put

Path parameters

agreementIdstringRequired

idstringRequired

Body

application/jsontext/jsonapplication/*+json

idstringOptional

auditall ofOptional

$metaall ofOptional

namestringOptional

typestringOptional

descriptionstringOptional

filenamestring | nullableOptional

sizeinteger · int32 | nullableOptional

contentTypestringOptional

orderIdstringOptional

licenseKeystringOptional

agreementall ofOptional

Responses

200

OK

application/json

403

Forbidden

application/json

404

Not Found

application/json

put

HTTPcURLJavaScriptPython

PUT /public/v1/commerce/agreements/{agreementId}/attachments/{id} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 698

{
  "id": "text",
  "audit": {
    "created": {
      "at": "2025-06-22T13:49:16.198Z",
      "by": {
        "0": "[",
        "1": "C",
        "2": "i",
        "3": "r",
        "4": "c",
        "5": "u",
        "6": "l",
        "7": "a",
        "8": "r",
        "9": " ",
        "10": "R",
        "11": "e",
        "12": "f",
        "13": "e",
        "14": "r",
        "15": "e",
        "16": "n",
        "17": "c",
        "18": "e",
        "19": "]"
      }
    },
    "updated": {
      "at": "2025-06-22T13:49:16.198Z",
      "by": {
        "0": "[",
        "1": "C",
        "2": "i",
        "3": "r",
        "4": "c",
        "5": "u",
        "6": "l",
        "7": "a",
        "8": "r",
        "9": " ",
        "10": "R",
        "11": "e",
        "12": "f",
        "13": "e",
        "14": "r",
        "15": "e",
        "16": "n",
        "17": "c",
        "18": "e",
        "19": "]"
      }
    }
  },
  "$meta": {
    "omitted": [
      "text"
    ]
  },
  "name": "text",
  "type": "text",
  "description": "text",
  "filename": "text",
  "size": 1,
  "contentType": "text",
  "orderId": "text",
  "licenseKey": "text",
  "agreement": {
    "id": "text",
    "icon": "text",
    "status": "text",
    "name": "text"
  }
}

application/jsontext/jsonapplication/*+json

{
  "id": "text",
  "audit": {
    "created": {
      "at": "2025-06-22T13:49:16.198Z",
      "by": {
        "0": "[",
        "1": "C",
        "2": "i",
        "3": "r",
        "4": "c",
        "5": "u",
        "6": "l",
        "7": "a",
        "8": "r",
        "9": " ",
        "10": "R",
        "11": "e",
        "12": "f",
        "13": "e",
        "14": "r",
        "15": "e",
        "16": "n",
        "17": "c",
        "18": "e",
        "19": "]"
      }
    },
    "updated": {
      "at": "2025-06-22T13:49:16.198Z",
      "by": {
        "0": "[",
        "1": "C",
        "2": "i",
        "3": "r",
        "4": "c",
        "5": "u",
        "6": "l",
        "7": "a",
        "8": "r",
        "9": " ",
        "10": "R",
        "11": "e",
        "12": "f",
        "13": "e",
        "14": "r",
        "15": "e",
        "16": "n",
        "17": "c",
        "18": "e",
        "19": "]"
      }
    }
  },
  "$meta": {
    "omitted": [
      "text"
    ]
  },
  "name": "text",
  "type": "text",
  "description": "text",
  "filename": "text",
  "size": 1,
  "contentType": "text",
  "orderId": "text",
  "licenseKey": "text",
  "agreement": {
    "id": "text",
    "icon": "text",
    "status": "text",
    "name": "text"
  }
}