Skip to main content
API Explorer|API Explorer
Infrastructure/Collects
POSTInfrastructureSince 1.0SynchronousAuth Required

PreviewTemplate

Preview a template by rendering it with provided variable values.

Execution Availability

Try It Out

Submit a mock request using the current auth context and example-driven inputs.

Path Parameters

Request Inputs

Path Parameters

  • idStringRequired

    Unique identifier of the template to preview

Responses

200 OK

On success, this API returns the following response structure.

  • dataObject

    The data value

    Example: (nested object)

Endpoint

POST/api/v1/collects/templates/{id}/preview

/api/v1/collects/templates/{id}/preview

Operation ID

PreviewTemplate

Permalink

Request Example

curl -X POST '{host}/api/v1/collects/templates/{id}/preview' -H 'Authorization: Bearer {token}' -H 'Content-Type: application/json' -d '{}'

Response Example

200
{
  "data": null
}

Change History

This API has no change history records yet.

View all change history