Get cost breakdown request link
request_cost_breakdown_linkReturns only the personal link (quoteRequestUrl) for one programme and family: the calculator page on goodbyematrix.com with the family already filled in, where the user requests the detailed cost breakdown with the exact amounts by e-mail from the GoodbyeMatrix team. Contact details (first name, last name, e-mail, phone) are optional; only details the user has provided and wants to pass on are used. They prefill the form on that page and are never part of the link; the link works without them. The user checks the details and sends the request personally; the privacy consent is never preselected.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| family | Yes | Everyone who applies together. The first person is the main applicant (role "main"); only the first person has the role "main". Defaults: a partner counts as married and not same-sex unless stated; a child under 18 counts as dependent. | |
| contact | No | Optional. Contact details are used only as the user has provided them in this conversation and wants to pass them on to GoodbyeMatrix; the link works without them. They prefill the request form on the page; they are not part of the link and the user still checks and sends the request personally. | |
| program | Yes | Programme key: sao_tome (Sao Tome and Principe), vanuatu, dominica, st_lucia (Saint Lucia), st_kitts (St. Kitts and Nevis), grenada, antigua (Antigua and Barbuda), nauru, argentina. | |
| language | No | Response language: "en" (English, default) or "de" (German). | en |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| program | Yes | ||
| language | Yes | ||
| programLabel | No | ||
| ignoredFields | No | Only when contact was given: contact fields that were invalid and dropped. | |
| quoteRequestUrl | Yes | Link to the calculator page with the family filled in, where the user requests the detailed cost breakdown by e-mail. | |
| contactPrefilled | No | Only when contact was given: true if at least one contact field was accepted and will prefill the form. |