Create a contact request

> ## Documentation Index
> Fetch the complete documentation index at: https://easybroker-staging.readme.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Create a contact request

Creates or updates a new lead in EasyBroker that is interested in the provided property.

# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "info": {
    "version": "1.0",
    "title": "EasyBroker API",
    "description": "API for accessing and working with EasyBroker accounts. To get started click the Authorize button below and enter your API key."
  },
  "externalDocs": {
    "description": "View the getting started guide in Spanish",
    "url": "https://dev.easybroker.com/docs/api-de-easybroker"
  },
  "security": [
    {
      "ApiKeyAuth": []
    }
  ],
  "servers": [
    {
      "url": "https://api.stagingeb.com/v1",
      "description": "API URL"
    }
  ],
  "paths": {
    "/contact_requests": {
      "post": {
        "tags": [
          "Contact Requests"
        ],
        "summary": "Create a contact request",
        "description": "Creates or updates a new lead in EasyBroker that is interested in the provided property.",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ContactRequestBody"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "A contact request was created",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "example": "successful"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "$ref": "#/components/responses/UnauthorizedError"
          },
          "404": {
            "description": "No property exists for the given property ID",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "error": {
                      "type": "string",
                      "example": "The specified property could not be found."
                    }
                  }
                }
              }
            }
          },
          "422": {
            "description": "The request couldn't be created because it is invalid",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "error": {
                      "type": "string",
                      "example": "You must specify a name, email or phone number."
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  },
  "components": {
    "responses": {
      "UnauthorizedError": {
        "description": "API key is missing or invalid",
        "content": {
          "application/json": {
            "schema": {
              "type": "object",
              "properties": {
                "error": {
                  "type": "string",
                  "example": "Your API key is invalid"
                }
              }
            }
          }
        }
      }
    },
    "schemas": {
      "ContactRequestBody": {
        "required": [
          "source"
        ],
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "example": "John Smith",
            "description": "Required if the request does not provide a property_id"
          },
          "phone": {
            "type": "string",
            "example": "5559090909",
            "description": "Required if the request does not provide neither a property id nor an email"
          },
          "email": {
            "type": "string",
            "example": "mail@example.com",
            "description": "Required if the request does not provide neither a property id nor a phone number"
          },
          "property_id": {
            "type": "string",
            "example": "EB-XXXX01",
            "description": "If the request provides this parameter, it should also provide a name, email or phone number"
          },
          "message": {
            "type": "string",
            "example": "I'm interested in this property. Please contact me.",
            "description": "Required if the request does not provide a property_id"
          },
          "source": {
            "type": "string",
            "example": "mydomain.com"
          }
        }
      }
    },
    "securitySchemes": {
      "ApiKeyAuth": {
        "type": "apiKey",
        "in": "header",
        "name": "X-Authorization",
        "description": "You can find your API key in the general settings section of your EasyBroker account. It's only accessible for account administrators."
      }
    }
  },
  "x-readme": {
    "explorer-enabled": true,
    "proxy-enabled": true
  },
  "_id": {
    "buffer": {
      "0": 99,
      "1": 142,
      "2": 110,
      "3": 111,
      "4": 217,
      "5": 194,
      "6": 135,
      "7": 0,
      "8": 24,
      "9": 185,
      "10": 196,
      "11": 37
    }
  }
}
```