---
title: "offer.start"
method: POST
path: "/offer.start"
tags: ["Offer"]
---

# offer.start

`POST /offer.start`

The offer.start endpoint creates and returns an offer version instance that can be filled out and submitted
using the `offer.create` endpoint.

In order to create a new offer version for a candidate with an in-progress
offer process, you can call the `offer.start` endpoint and then call the `offer.create` endpoint to fill out the
newly created offer version form.

**Requires the [`offersWrite`](authentication#permissions-offerstart) permission.**

## Request body

- OfferStartRequest
  - `offerProcessId` string, uuid, required — The ID of the offer process to start. This value is the id included in the response of the `offerProcess.start` API.

## Response `200`

Responses from the offer.start endpoint

- union
  - OfferStartSuccessResponse
    - `success` true, required
    - `results` OfferStartResult, required
      - `id` string, uuid, required — The id of the newly created offer form
      - `formDefinition` FormDefinition, required
        - `sections` FormDefinitionSection[], required — The sections in the form definition
          - `title` string, nullable — The section title
          - `descriptionHtml` string, nullable — The section description formatted as HTML
          - `descriptionPlain` string, nullable — The section description as plain text
          - `fields` FormDefinitionFieldEntry[], required — The fields in this form section
            - `isRequired` boolean, required — Whether this form field is required
            - `descriptionHtml` string, nullable — The field description formatted as HTML
            - `descriptionPlain` string, nullable — The field description as plain text
            - `field` FormDefinitionField, required
              - …
  - ErrorResponse
    - `success` false, required
    - `errors` ErrorDetail[], required
      - `message` string, required
      - `parameter` string

---

[API](https://skmtc.net/ashbyhq/apis/ashby-api.md) · [All operations](https://skmtc.net/ashbyhq/apis/ashby-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/ashbyhq/ashby-api/revisions/778b919dc743/schema)