letter-v2

Preview Profile

Test-compile the profile's templates with sample data (Max Mustermann) and return the letter PDF (?envelope=true for the envelope PDF). A successful preview sets the profile's validated flag.

post/letter-v2/profiles/{profile_id}/preview

Request

  • Base URL: https://api.overfit.de (the document declares no server; this is the origin it was published from)
  • URL: https://api.overfit.de/letter-v2/profiles/{profile_id}/preview
  • Auth: one of:
    • OpenID Connect (https://auth.okns.de/realms/overfit-products/.well-known/openid-configuration)
    • API key in header X-API-Key

Path parameters

profile_idstring required

Query parameters

envelopeboolean

Response

Successful Response

unknown required

Changes

No recorded changes to this operation across all 1 revision of this API.