Rendering

API for updates on renderings

This API can be used to update comments on renderings

PATCH/api/renderings/{id}

API for updates on renderings

curl --request PATCH \
  --url 'https://app.output.rocks/api/renderings/string' \
  --header 'X-AUTH-TOKEN: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
  "comment": "My Comment"
}'

200

application/json

{
  "id": 12345,
  "externalId": "external-id",
  "template": "my-invoice",
  "format": "pdf",
  "webhook": "my-webhook",
  "comment": "My Comment",
  "emailServer": "my-smtp"
}

Authorizations

X-AUTH-TOKEN

stringheaderrequired

Value for the X-AUTH-TOKEN header parameter.

Path Parameters

stringrequired

Rendering identifier

Request Body

application/json

required

The updated Rendering resource

{
  "comment": "My Comment"
}

Response

200application/json

Rendering resource updated

integer

Identifier generated by Output.Rocks.

Example: 12345

externalId

string

External id

Example: "external-id"

template

stringrequired

Template identifier.

Example: "my-invoice"

format

enum<string>

Document format to render

Available options: pdfdocodtrtfhtmltxt

Example: "pdf"

webhook

string

Webhook (identifier) to execute after document rendering.

Example: "my-webhook"

comment

string

Rendering Comment.

Example: "My Comment"

emailServer

string

Identifier of Email-Server configuration in Output.Rocks

Example: "my-smtp"