---
title: "Create a Capture Request"
method: POST
path: "/api/v2/capture_requests"
---

# Create a Capture Request

`POST /api/v2/capture_requests`

## Request body

- object
  - `capture_request` object
    - `capturing_user_email` string — Required. The email address of the person this capture request will be sent to.
    - `capturing_user_phone` string — Optional. The phone number of the person this capture request will be sent to.
    - `capturing_user_name` string — Required. The name of the person that will be capturing the property. Most likely the homeowner's name.
    - `signup_type` string — Optional. Defaults to `homeowner`. Allowed values are `homeowner` and `pro`, designated by the type of user capturing the property.
    - `job_attributes` object
      - `name` string — A name for the job.
      - `deliverable_id` string — Supported deliverable_ids: 2(Roof Only), 3(Complete), 5(Total Living Area Plus), 6 (Total Living Area), 7 (Capture Only, Photos Only), 8 (Interior)
      - `external_identifier` string — A unique identifier generated by the client. This can be anything you want and won't be changed. It can be used to reference an ID in the an external system database.
      - `location_city` string — The city where this job is located.
      - `location_line_1` string — First line of this job's address
      - `location_line_2` string — Second line of this job's address
      - `location_postal_code` string — The postal code of this job's address
      - `location_region` string — The 2 character state code where this job resides.
      - `suppress_email` boolean — If a value other than false is given for this attribute then all emails related to this job will be suppressed. That includes capture request emails.
      - `wallet_id` integer — Optional. By passing this parameter you can specify the billing information for the job.
    - `suppress_text_messages` string — If a value other than false is given for this attribute then all SMS related to this job will be suppressed. That includes capture request SMS..
  - `current_user_email` string — The internal user that you want to assign the job to. Alternatively, you can also use the `current_user_id` param.
  - `current_user_id` integer — The ID value of the user who you want to assign the job to. Alternatively, current_user_email can be used.

## Response `200`

200

- object

## Other responses

- `400` — 400

---

[API](https://skmtc.net/hover/apis/hover-api-v3.md) · [All operations](https://skmtc.net/hover/apis/hover-api-v3/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/hover/hover-api-v3/revisions/98ae3699d4c9/schema)