YourNextHome
API ReferenceInquiry

Update inquiry

PATCH
/api/v1/inquiry/{id}

Path Parameters

id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

curl -X PATCH "https://example.com/api/v1/inquiry/string" \  -H "Content-Type: application/json" \  -d '{    "status": "NEW"  }'
{
  "id": "b6c6b5b6-7b1d-4b8f-8f5e-5e8f4b1d7b6b",
  "name": "John Doe",
  "email": "example@email.com",
  "referralUserId": "b6c6b5b6-7b1d-4b8f-8f5e-5e8f4b1d7b6b",
  "referralUser": {
    "id": "string",
    "firstName": "string",
    "lastName": "string",
    "avatarUrl": "string",
    "jobTitle": "string",
    "description": "string",
    "email": "string",
    "role": "admin",
    "createdAt": "2019-08-24T14:15:22Z",
    "isRegistered": true,
    "organizationMemberships": [
      {
        "id": "string",
        "userId": "string",
        "organizationId": "string",
        "organization": {
          "id": "string",
          "name": "string",
          "featureFlags": [
            "estates"
          ]
        },
        "role": "string",
        "createdAt": "2019-08-24T14:15:22Z"
      }
    ]
  },
  "estateId": "b6c6b5b6-7b1d-4b8f-8f5e-5e8f4b1d7b6b",
  "apartmentIds": [
    "b6c6b5b6-7b1d-4b8f-8f5e-5e8f4b1d7b6b"
  ],
  "status": "NEW",
  "phoneNumber": "0123456789",
  "info": "Some additional info",
  "createdAt": "2022-01-01T00:00:00.000Z",
  "updatedAt": "2022-01-01T00:00:00.000Z"
}