Export html to other format

Exports structured table content as a downloadable Excel or Word file, based on the requested format.

POST /++exportHTMLToOtherFormat

Platform & Utilities

Authentication

Requires an authenticated (logged-in) account. Also requires a registered Integrator subscription.

This endpoint requires the calling application to be registered as an Integrator. Every call must identify the registration via a registration_id parameter (or an X-Client-Id header), and authenticate using one of the following methods, selected with the subscription_method parameter:

  • referer — The request's HTTP Referer header must match one of the domains authorized for this Integrator registration.
  • ip — The request's source IP address must match one of the IP addresses authorized for this Integrator registration.
  • client_token — A client token issued at registration time is supplied with the request.

Register as an Integrator and configure authorized domains, IP addresses, or a client token.

Request

Content type: application/octet-stream

NameInTypeRequiredDescription
BODYbodystringNo—
contentbodystringNo—
formatbodystringNo—
brandingbodystringNoSent by the web client (found via frontend call-site tracing).
menubarbodystringNoSent by the web client (found via frontend call-site tracing).
pluginsbodystringNoSent by the web client (found via frontend call-site tracing).
promotionbodystringNoSent by the web client (found via frontend call-site tracing).
toolbarbodystringNoSent by the web client (found via frontend call-site tracing).

Example request body

{
  "BODY": "example_value",
  "content": "example_value",
  "format": "example_value",
  "branding": "example_value",
  "menubar": "example_value",
  "plugins": "example_value",
  "promotion": "example_value",
  "toolbar": "example_value"
}

Responses

StatusMeaning
200Successful response.
401Unauthorized - missing or invalid Integrator authentication (registration_id/X-Client-Id, plus referer/IP/client_token).
403Forbidden - the current user or Integrator registration does not have sufficient permissions.

Example response (illustrative - field names only, values are placeholders)

{
  "error": "example_value"
}