> For the complete documentation index, see [llms.txt](https://partner-docs.covergenius.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://partner-docs.covergenius.com/offers/api/reference/confirm-offer.md). # Confirm Offer ## Confirm Offer > The Confirm Offer endpoint is used to finalize the purchase of products from a previously created Offer. This endpoint converts the selected Offer into a confirmed booking after payment has been successfully collected.\ > \### Idempotency\ > This endpoint supports idempotency keys via the \`x-idempotency-key\` header to prevent duplicate transactions. Provide a unique operation identifier (e.g., UUID) to ensure safe retries. Duplicate requests return:\ > \- \*\*409 Conflict\*\*: The request was already processed; response contains\ > the cached original result (handle as success)\ > \- \*\*423 Locked\*\*: The original request is still processing; retry after\ > a short delay ```json {"openapi":"3.0.0","info":{"title":"Offers API","version":"1.0.0"},"servers":[{"url":"https://api.xcover.com/x"}],"security":[{"CustomAPISignature":[]}],"components":{"securitySchemes":{"CustomAPISignature":{"type":"apiKey","name":"Authorization","in":"header","description":"**Composite Authentication Scheme (Client Key, Date, and Signature)**\n\nThis scheme requires the client to provide **three** mandatory headers in every request:\n\n### 1. X-Api-Key (Client Key)\n* **Purpose:** Public identifier for the API consumer.\n* **Example:** `X-Api-Key: YOUR_API_KEY_HERE`\n\n### 2. Date (Timestamp)\n* **Purpose:** Timestamp used for generating the signature and preventing replay attacks.\n* **Format:** RFC 7231 format (e.g., in GMT).\n* **Example:** `Date: Sun, 09 Nov 2025 04:04:00 GMT`\n\n### 3. Authorization (Computed Signature)\n* **Purpose:** The cryptographic signature that verifies the request's authenticity and integrity.\n* **Format:** `SIGNATURE [authHeader]`\n\n**Signature Generation Logic:**\nThe `authHeader` value is derived from a cryptographic hash (e.g., HMAC-SHA256) of canonical request components (HTTP Method, Path, and the contents of the `Date` header), signed with the private **Client Secret**.\n"}},"parameters":{"ApiErrorVersion":{"name":"X-API-Error-Version","in":"header","required":false,"description":"Opt-in selector for the shape of non-2xx response bodies. `v1` (the default) returns the legacy error body. `v2` returns the structured error body described by `ErrorV2`. Matched case-insensitively. An absent, empty or unrecognised value falls back to `v1` and never fails an otherwise-valid request.","schema":{"type":"string","enum":["v1","v2"],"default":"v1"}}},"schemas":{"ErrorV1":{"type":"object","description":"Legacy error body. Returned unless `X-API-Error-Version: v2` is sent.","properties":{"type":{"type":"string"},"message":{"type":"string"},"errors":{"type":"object","nullable":true,"description":"Field-keyed validation errors, when applicable."}}},"ErrorV2":{"type":"object","description":"Structured error body, returned when `X-API-Error-Version: v2` is sent. `code`, `error_id`, `errors` and `metadata` are always present, the last two as an empty array/object when there is nothing to report, so they can be read unconditionally. `error_id` is null when the failing path minted no id (an auth or throttle rejection, say). Any field-keyed errors the `v1` body would have carried are preserved under `metadata.field_errors`.\n\nOne limit: an error that produces no framework response (a server-rendered 500) is not reshaped and stays in the `v1` form.","properties":{"type":{"type":"string"},"message":{"type":"string"},"code":{"type":"string","description":"Machine-readable error code for the response as a whole."},"error_id":{"type":"string","nullable":true,"description":"Identifier for this failure, null when none was minted."},"errors":{"type":"array","description":"Structured error entries. Empty when there is nothing to itemise.","items":{"$ref":"#/components/schemas/ErrorItemV2"}},"metadata":{"type":"object","description":"Supplementary context. Empty object when there is nothing to report. Field-keyed errors from the `v1` shape appear here under `field_errors`."}}},"ErrorItemV2":{"type":"object","description":"A single structured error entry.","properties":{"product_config_id":{"type":"string","nullable":true,"description":"Product configuration the error relates to, when applicable."},"quote_id":{"type":"string","nullable":true,"description":"Quote the error relates to, when applicable."},"code":{"type":"string","description":"Machine-readable error code for this item."},"details":{"type":"array","description":"Human-readable detail messages.","items":{"type":"string"}}}}}},"paths":{"/partners/{partner_code}/offers/{offer_id}/confirm/":{"post":{"summary":"Confirm Offer","description":"The Confirm Offer endpoint is used to finalize the purchase of products from a previously created Offer. This endpoint converts the selected Offer into a confirmed booking after payment has been successfully collected.\n### Idempotency\nThis endpoint supports idempotency keys via the `x-idempotency-key` header to prevent duplicate transactions. Provide a unique operation identifier (e.g., UUID) to ensure safe retries. Duplicate requests return:\n- **409 Conflict**: The request was already processed; response contains\n the cached original result (handle as success)\n- **423 Locked**: The original request is still processing; retry after\n a short delay","tags":["Confirm Offer"],"parameters":[{"$ref":"#/components/parameters/ApiErrorVersion"},{"name":"x-idempotency-key","in":"header","required":false,"description":"A unique identifier to ensure idempotent request processing. If a request with the same idempotency key and body has already been processed, the cached response is returned with a `409` Conflict status code (which can be treated as successful). Keys are stored for 48 hours.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"OK","headers":{"Date":{"schema":{"deprecated":false}},"Transfer-Encoding":{"schema":{"deprecated":false}},"Connection":{"schema":{"deprecated":false}},"CF-Ray":{"schema":{"deprecated":false}},"CF-Cache-Status":{"schema":{"deprecated":false}},"Allow":{"schema":{"deprecated":false}},"Server":{"schema":{"deprecated":false}},"Strict-Transport-Security":{"schema":{"deprecated":false}},"content-security-policy":{"schema":{"deprecated":false}},"cross-origin-opener-policy":{"schema":{"deprecated":false}},"referrer-policy":{"schema":{"deprecated":false}},"Vary":{"schema":{"deprecated":false}},"Content-Encoding":{"schema":{"deprecated":false}},"Server-Timing":{"schema":{"deprecated":false}},"Cf-Team":{"schema":{"deprecated":false}}},"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"status":{"type":"string"},"currency":{"type":"string"},"total_price":{"type":"number"},"total_price_formatted":{"type":"string"},"partner_transaction_id":{"nullable":true},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"pds_url":{"type":"string","format":"uri"},"security_token":{"type":"string"},"quotes":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"policy_start_date":{"type":"string","format":"date-time"},"policy_end_date":{"type":"string","format":"date-time"},"status":{"type":"string"},"price":{"type":"number"},"price_formatted":{"type":"string"},"policy":{"type":"object","properties":{"policy_type":{"type":"string"},"policy_type_version":{"type":"string","format":"utc-millisec"},"policy_type_slug":{"type":"string"},"policy_type_group_name":{"type":"string"},"policy_name":{"type":"string"},"policy_code":{"type":"string"},"policy_version":{"type":"string"},"category":{"type":"string"},"content":{"type":"object","properties":{"title":{"type":"string"},"header":{"nullable":true},"description":{"type":"string"},"optout_msg":{"type":"string"},"inclusions":{"type":"array","items":{"type":"object","properties":{"title":{"type":"string"},"description":{"type":"string"}}}},"exclusions":{"type":"array","items":{}},"disclaimer":{"type":"string","format":"style"},"disclaimer_html":{"type":"string","format":"style"},"payment_disclaimer":{"type":"string"},"in_path_disclaimer":{"type":"string"},"extra_content":{"type":"object"}}},"underwriter":{"type":"object","properties":{"disclaimer":{"type":"string"},"name":{"type":"string"}}},"claim_selector_id":{"nullable":true},"policy_currency":{"type":"string"}}},"insured":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"first_name":{"type":"string"},"last_name":{"type":"string"},"email":{"type":"string","format":"email"},"region":{"nullable":true}}}},"tax":{"type":"object","properties":{"total_tax":{"type":"number"},"total_amount_without_tax":{"type":"number"},"taxes":{"type":"array","items":{"type":"object","properties":{"tax_amount":{"type":"number"},"tax_code":{"type":"string"},"tax_amount_formatted":{"type":"string"}}}},"total_tax_formatted":{"type":"string"},"total_amount_without_tax_formatted":{"type":"string"}}},"duration":{"type":"string","format":"style"},"benefits":{"type":"array","items":{"type":"object","properties":{"benefit_content_id":{"type":"string"},"description":{"type":"string"},"extra_content":{"type":"object","properties":{"benefit-text-test":{"type":"string"},"benefit_rich_text_test":{"type":"string"}}},"limit":{"type":"integer"},"limit_policy_currency":{"type":"integer"},"limit_formatted":{"type":"string"},"limit_policy_currency_formatted":{"type":"string"},"excess":{"type":"integer"},"excess_policy_currency":{"type":"integer"},"excess_formatted":{"type":"string"},"excess_policy_currency_formatted":{"type":"string"}}}},"commission":{"type":"object","properties":{"partner_commission":{"type":"number"},"surcharge_commission":{"type":"integer"},"total_commission":{"type":"number"},"partner_commission_formatted":{"type":"string"},"surcharge_commission_formatted":{"type":"string"},"total_commission_formatted":{"type":"string"}}},"created_at":{"type":"string","format":"date-time"},"confirmed_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"cancelled_at":{"nullable":true},"cancelled_from":{"nullable":true},"is_renewable":{"type":"boolean"},"is_pricebeat_enabled":{"nullable":true},"cover_amount":{"type":"integer"},"cover_amount_formatted":{"type":"string"},"pds_url":{"type":"string","format":"uri"},"attachments":{"type":"array","items":{}},"files":{"type":"array","items":{}},"custom_documents":{"nullable":true},"extra_fields":{"type":"object","properties":{"destination_region":{"type":"string"},"seller_entity":{"type":"string"},"age_brackets":{"type":"string"},"desitnation_sanctions":{"type":"array","items":{}},"sanctioned_distination_countries":{"type":"array","items":{"type":"string"}},"test_underwrting_rule":{"type":"boolean"}}},"surcharge":{"type":"object","properties":{"total_amount":{"nullable":true},"surcharges":{"nullable":true},"total_amount_formatted":{"type":"string"}}},"parent_quote_status":{"nullable":true},"experiment":{"nullable":true},"next_renewal":{"nullable":true},"can_be_cancelled":{"type":"boolean"},"third_party_admins":{"type":"array","items":{}},"ombudsman_list":{"type":"array","items":{}},"cancellation_info":{"type":"object","properties":{"reason_for_cancellation":{"type":"string"}}}}}},"coi":{"type":"object","properties":{"url":{"type":"string","format":"uri"},"pdf":{"type":"string","format":"uri"}}},"account_url":{"type":"string","format":"uri"},"sign_up_url":{"type":"string","format":"uri"},"policyholder":{"type":"object","properties":{"first_name":{"type":"string"},"last_name":{"type":"string"},"email":{"type":"string","format":"email"},"phone":{"nullable":true},"address1":{"nullable":true},"address2":{"nullable":true},"postcode":{"type":"string","format":"utc-millisec"},"company":{"nullable":true},"company_reg_id":{"nullable":true},"middle_name":{"nullable":true},"country":{"type":"string"},"age":{"type":"integer"},"city":{"nullable":true},"region":{"type":"string"},"secondary_email":{"nullable":true},"birth_date":{"nullable":true},"allow_updates":{"type":"boolean"},"fields_allowed_to_update":{"type":"array","items":{}}}},"total_tax":{"type":"number"},"total_tax_formatted":{"type":"string"},"total_premium":{"type":"number"},"total_premium_formatted":{"type":"string"},"fnol_link":{"type":"string","format":"uri"},"booking_agent":{"nullable":true}}}}}},"403":{"description":"Forbidden","headers":{"Date":{"schema":{"deprecated":false}},"Transfer-Encoding":{"schema":{"deprecated":false}},"Connection":{"schema":{"deprecated":false}},"CF-Ray":{"schema":{"deprecated":false}},"CF-Cache-Status":{"schema":{"deprecated":false}},"Allow":{"schema":{"deprecated":false}},"Server":{"schema":{"deprecated":false}},"Strict-Transport-Security":{"schema":{"deprecated":false}},"cross-origin-opener-policy":{"schema":{"deprecated":false}},"referrer-policy":{"schema":{"deprecated":false}},"Vary":{"schema":{"deprecated":false}},"Content-Encoding":{"schema":{"deprecated":false}},"Server-Timing":{"schema":{"deprecated":false}},"Cf-Team":{"schema":{"deprecated":false}}},"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/ErrorV1"},{"$ref":"#/components/schemas/ErrorV2"}]}}}},"404":{"description":"Not Found","headers":{"Date":{"schema":{"type":"string"}},"Transfer-Encoding":{"schema":{"type":"string"}},"Connection":{"schema":{"type":"string"}},"CF-Ray":{"schema":{"type":"integer"}},"CF-Cache-Status":{"schema":{"type":"string"}},"Allow":{"schema":{"type":"string"}},"Server":{"schema":{"type":"string"}},"Strict-Transport-Security":{"schema":{"type":"string"}},"cross-origin-opener-policy":{"schema":{"type":"string"}},"referrer-policy":{"schema":{"type":"string"}},"Vary":{"schema":{"type":"string"}},"Content-Encoding":{"schema":{"type":"string"}},"Server-Timing":{"schema":{"type":"string"}},"Cf-Team":{"schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/ErrorV1"},{"$ref":"#/components/schemas/ErrorV2"}]}}}},"409":{"description":"Conflict - Duplicate Request (Idempotent)","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"status":{"type":"string"},"currency":{"type":"string"},"total_price":{"type":"number"},"total_price_formatted":{"type":"string"},"partner_transaction_id":{"nullable":true},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"pds_url":{"type":"string","format":"uri"},"security_token":{"type":"string"},"quotes":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"policy_start_date":{"type":"string","format":"date-time"},"policy_end_date":{"type":"string","format":"date-time"},"status":{"type":"string"},"price":{"type":"number"},"price_formatted":{"type":"string"},"policy":{"type":"object","properties":{"policy_type":{"type":"string"},"policy_type_version":{"type":"string","format":"utc-millisec"},"policy_type_slug":{"type":"string"},"policy_type_group_name":{"type":"string"},"policy_name":{"type":"string"},"policy_code":{"type":"string"},"policy_version":{"type":"string"},"category":{"type":"string"},"content":{"type":"object","properties":{"title":{"type":"string"},"header":{"nullable":true},"description":{"type":"string"},"optout_msg":{"type":"string"},"inclusions":{"type":"array","items":{"type":"object","properties":{"title":{"type":"string"},"description":{"type":"string"}}}},"exclusions":{"type":"array","items":{}},"disclaimer":{"type":"string","format":"style"},"disclaimer_html":{"type":"string","format":"style"},"payment_disclaimer":{"type":"string"},"in_path_disclaimer":{"type":"string"},"extra_content":{"type":"object"}}},"underwriter":{"type":"object","properties":{"disclaimer":{"type":"string"},"name":{"type":"string"}}},"claim_selector_id":{"nullable":true},"policy_currency":{"type":"string"}}},"insured":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"first_name":{"type":"string"},"last_name":{"type":"string"},"email":{"type":"string","format":"email"},"region":{"nullable":true}}}},"tax":{"type":"object","properties":{"total_tax":{"type":"number"},"total_amount_without_tax":{"type":"number"},"taxes":{"type":"array","items":{"type":"object","properties":{"tax_amount":{"type":"number"},"tax_code":{"type":"string"},"tax_amount_formatted":{"type":"string"}}}},"total_tax_formatted":{"type":"string"},"total_amount_without_tax_formatted":{"type":"string"}}},"duration":{"type":"string","format":"style"},"benefits":{"type":"array","items":{"type":"object","properties":{"benefit_content_id":{"type":"string"},"description":{"type":"string"},"extra_content":{"type":"object","properties":{"benefit-text-test":{"type":"string"},"benefit_rich_text_test":{"type":"string"}}},"limit":{"type":"integer"},"limit_policy_currency":{"type":"integer"},"limit_formatted":{"type":"string"},"limit_policy_currency_formatted":{"type":"string"},"excess":{"type":"integer"},"excess_policy_currency":{"type":"integer"},"excess_formatted":{"type":"string"},"excess_policy_currency_formatted":{"type":"string"}}}},"commission":{"type":"object","properties":{"partner_commission":{"type":"number"},"surcharge_commission":{"type":"integer"},"total_commission":{"type":"number"},"partner_commission_formatted":{"type":"string"},"surcharge_commission_formatted":{"type":"string"},"total_commission_formatted":{"type":"string"}}},"created_at":{"type":"string","format":"date-time"},"confirmed_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"cancelled_at":{"nullable":true},"cancelled_from":{"nullable":true},"is_renewable":{"type":"boolean"},"is_pricebeat_enabled":{"nullable":true},"cover_amount":{"type":"integer"},"cover_amount_formatted":{"type":"string"},"pds_url":{"type":"string","format":"uri"},"attachments":{"type":"array","items":{}},"files":{"type":"array","items":{}},"custom_documents":{"nullable":true},"extra_fields":{"type":"object","properties":{"destination_region":{"type":"string"},"seller_entity":{"type":"string"},"age_brackets":{"type":"string"},"desitnation_sanctions":{"type":"array","items":{}},"sanctioned_distination_countries":{"type":"array","items":{"type":"string"}},"test_underwrting_rule":{"type":"boolean"}}},"surcharge":{"type":"object","properties":{"total_amount":{"nullable":true},"surcharges":{"nullable":true},"total_amount_formatted":{"type":"string"}}},"parent_quote_status":{"nullable":true},"experiment":{"nullable":true},"next_renewal":{"nullable":true},"can_be_cancelled":{"type":"boolean"},"third_party_admins":{"type":"array","items":{}},"ombudsman_list":{"type":"array","items":{}},"cancellation_info":{"type":"object","properties":{"reason_for_cancellation":{"type":"string"}}}}}},"coi":{"type":"object","properties":{"url":{"type":"string","format":"uri"},"pdf":{"type":"string","format":"uri"}}},"account_url":{"type":"string","format":"uri"},"sign_up_url":{"type":"string","format":"uri"},"policyholder":{"type":"object","properties":{"first_name":{"type":"string"},"last_name":{"type":"string"},"email":{"type":"string","format":"email"},"phone":{"nullable":true},"address1":{"nullable":true},"address2":{"nullable":true},"postcode":{"type":"string","format":"utc-millisec"},"company":{"nullable":true},"company_reg_id":{"nullable":true},"middle_name":{"nullable":true},"country":{"type":"string"},"age":{"type":"integer"},"city":{"nullable":true},"region":{"type":"string"},"secondary_email":{"nullable":true},"birth_date":{"nullable":true},"allow_updates":{"type":"boolean"},"fields_allowed_to_update":{"type":"array","items":{}}}},"total_tax":{"type":"number"},"total_tax_formatted":{"type":"string"},"total_premium":{"type":"number"},"total_premium_formatted":{"type":"string"},"fnol_link":{"type":"string","format":"uri"},"booking_agent":{"nullable":true}}}}}},"422":{"description":"Unprocessable Entity","headers":{"Date":{"schema":{"type":"string"}},"Content-Length":{"schema":{"type":"integer"}},"Connection":{"schema":{"type":"string"}},"CF-Ray":{"schema":{"type":"integer"}},"CF-Cache-Status":{"schema":{"type":"string"}},"Allow":{"schema":{"type":"string"}},"Server":{"schema":{"type":"string"}},"Strict-Transport-Security":{"schema":{"type":"string"}},"cross-origin-opener-policy":{"schema":{"type":"string"}},"referrer-policy":{"schema":{"type":"string"}},"Vary":{"schema":{"type":"string"}},"Server-Timing":{"schema":{"type":"string"}},"Cf-Team":{"schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"type":{"type":"string"},"message":{"type":"string"},"errors":{"type":"array","items":{"type":"string"}}}},{"$ref":"#/components/schemas/ErrorV2"}]}}}},"423":{"description":"Locked - Request In Progress","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/ErrorV1"},{"$ref":"#/components/schemas/ErrorV2"}]}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/ErrorV1"},{"$ref":"#/components/schemas/ErrorV2"}]}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"quotes":{"type":"array","description":"Array of quote objects to confirm","items":{"type":"object","properties":{"id":{"type":"string","description":"The product ID (quote ID) from the offer response"},"insured":{"type":"array","description":"List of insured persons if required by the policy","items":{"type":"object","properties":{"first_name":{"type":"string"},"last_name":{"type":"string"},"email":{"type":"string","format":"email"},"birth_date":{"type":"string","format":"date"},"country":{"type":"string"},"city":{"type":"string"},"postcode":{"type":"string"},"region":{"type":"string"},"age":{"type":"integer"}}}},"instalment_plan":{"type":"string","description":"Selected instalment plan name"},"first_instalment_paid":{"type":"boolean","description":"Whether first instalment has been paid"}},"required":["id"]}},"policyholder":{"type":"object","description":"Policyholder information","properties":{"first_name":{"type":"string","description":"Policyholder's first name"},"last_name":{"type":"string","description":"Policyholder's last name"},"email":{"type":"string","format":"email","description":"Policyholder's email address"},"phone":{"type":"string","description":"Policyholder's phone number"},"country":{"type":"string","description":"Policyholder's country code"},"region":{"type":"string","description":"Policyholder's region or state"},"city":{"type":"string","description":"Policyholder's city"},"postcode":{"type":"string","description":"Policyholder's postal code"},"address1":{"type":"string","description":"Policyholder's address line 1"},"address2":{"type":"string","description":"Policyholder's address line 2"}},"required":["first_name","last_name","email","phone","country"]},"require_payment_confirmation":{"type":"boolean","default":false,"description":"Enables two-step confirmation. If `true`, the booking is left in `PENDING_PAYMENT` until you call `Confirm booking` endpoint. Defaults to `false`, confirming in one step."},"partner_transaction_id":{"type":"string","description":"Your internal transaction identifier"},"partner_transaction_ref":{"type":"string","maxLength":255,"description":"An additional partner-side reference for this transaction."},"payment_details":{"type":"object","description":"Payment information","properties":{"provider":{"type":"string","description":"Payment provider name (e.g., stripe, paypal, xpay)"},"transaction_id":{"type":"string","description":"Payment transaction ID"},"xpay_charge_id":{"type":"string","description":"XPay charge ID if using XPay"},"xpay_customer_id":{"type":"string","description":"XPay customer ID if using XPay"},"customer_token_id":{"type":"string","description":"Customer token for payment authorization"}}},"booking_agent":{"type":"object","description":"Agent information if booked through an agent"}},"required":["quotes","policyholder"]}}}}}}}} ``` --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://partner-docs.covergenius.com/offers/api/reference/confirm-offer.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.