Render Agreement Template

put

/v1/commerce/agreements/{agreementId}/attachments/{id}

Path parameters

agreementIdstringrequired

idstringrequired

Body

application/jsontext/jsonapplication/*+json

idstring

auditobject

$metaobject

hrefstring

namestring

typestring

descriptionstring

filenamestring | nullable

sizeinteger · int32 | nullable

contentTypestring

orderIdstring

licenseKeystring

agreementobject

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url 'https://api.platform.softwareone.com/public/v1/commerce/agreements/{agreementId}/attachments/{id}' \
  --header 'Content-Type: application/json' \
  --data '{"audit":{},"$meta":{},"agreement":{}}'

200

403

404

200

{
  "id": "text",
  "audit": {},
  "$meta": {},
  "href": "text",
  "name": "text",
  "type": "text",
  "description": "text",
  "filename": "text",
  "size": 1,
  "contentType": "text",
  "orderId": "text",
  "licenseKey": "text",
  "agreement": {}
}

Success