Bid Request

Create Bid Request

This route creates a bid request based on a person and their property.

post/v0/bid-request

Request body

idstring required

Unique identifier of the bid request

instructionsstring required

Instructions for the quoting team

urlstring uri required

URL to access the resource

organizationIdstring

Organization to which the bid request belongs

Example request

{
  "id": "XXXX1234",
  "organizationId": "remi",
  "instructions": "These instructions will be sent to the quoting team. Please include any additional details that may be helpful for the quoting team to understand the request.",
  "url": "https://www.example.com/job/123",
  "files": [
    {
      "name": "completed-work-photo.jpg",
      "type": "photo",
      "url": "https://XXXXXXX.cloudfront.net/XXXXXX?Expires=1720732800&Signature=XXXXXX&Key-Pair-Id=XXXXXX"
    }
  ],
  "propertyAddress": {
    "addressStreet": "123 Main St",
    "city": "Anytown",
    "stateCode": "CA",
    "zip": "12345",
    "additionalInformation": "Unit 2B",
    "gateCode": "1234",
    "isHoaApprovalRequired": true
  },
  "billingAddress": {
    "addressStreet": "123 Main St",
    "city": "Anytown",
    "stateCode": "CA",
    "zip": "12345",
    "additionalInformation": "Unit 2B",
    "gateCode": "1234",
    "isHoaApprovalRequired": true
  },
  "homeowner": {
    "firstName": "John",
    "lastName": "Doe",
    "email": "john.doe@example.com",
    "phone": "555-123-4567",
    "phoneExtension": "123",
    "preferredLanguage": "ENGLISH",
    "preferredContactMethod": "EMAIL"
  }
}

Response

Bid created successfully

messagestring required

Message indicating the bid was created successfully

Example response

{
  "message": "Bid created successfully"
}

Changes

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