curl --request POST \
  --url https://api.immoteur.com/public/v1/issues \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "issueKind": "data",
  "propertyId": "019e5500-0000-7000-8000-000000000001",
  "issueFacets": [
    "price"
  ]
}
'

{
  "createdAt": "2023-11-07T05:31:56Z",
  "reportId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

{
  "code": "resource_not_found",
  "detail": "The requested resource could not be found.",
  "instance": "/public/v1/properties/019c12dc-339f-72ce-98db-663b44c0d924",
  "status": 404,
  "title": "Resource not found",
  "traceId": "b94f4db5-2f5e-4b8f-9dd0-f2fe5c7a7a4f",
  "type": "https://docs.immoteur.com/problems/resource_not_found"
}

{
  "code": "resource_not_found",
  "detail": "The requested resource could not be found.",
  "instance": "/public/v1/properties/019c12dc-339f-72ce-98db-663b44c0d924",
  "status": 404,
  "title": "Resource not found",
  "traceId": "b94f4db5-2f5e-4b8f-9dd0-f2fe5c7a7a4f",
  "type": "https://docs.immoteur.com/problems/resource_not_found"
}

{
  "code": "resource_not_found",
  "detail": "The requested resource could not be found.",
  "instance": "/public/v1/properties/019c12dc-339f-72ce-98db-663b44c0d924",
  "status": 404,
  "title": "Resource not found",
  "traceId": "b94f4db5-2f5e-4b8f-9dd0-f2fe5c7a7a4f",
  "type": "https://docs.immoteur.com/problems/resource_not_found"
}

{
  "message": "Data access (SIREN / SIRET / Department) not configured.",
  "configurationUrl": "https://immoteur.com/en/dashboard/billing#data-access",
  "documentationUrl": "https://docs.immoteur.com/pages/en/introduction"
}

{
  "code": "validation_error",
  "detail": "One or more request fields are invalid.",
  "instance": "/public/v1/properties/search",
  "status": 422,
  "title": "Validation error",
  "traceId": "4bdb0c23-53fc-4d14-a300-c63eb420ec5e",
  "type": "https://docs.immoteur.com/problems/validation_error",
  "violations": [
    {
      "code": "validation",
      "field": "id",
      "message": "The id field must be a valid UUID."
    }
  ]
}

{
  "code": "resource_not_found",
  "detail": "The requested resource could not be found.",
  "instance": "/public/v1/properties/019c12dc-339f-72ce-98db-663b44c0d924",
  "status": 404,
  "title": "Resource not found",
  "traceId": "b94f4db5-2f5e-4b8f-9dd0-f2fe5c7a7a4f",
  "type": "https://docs.immoteur.com/problems/resource_not_found"
}

{
  "code": "resource_not_found",
  "detail": "The requested resource could not be found.",
  "instance": "/public/v1/properties/019c12dc-339f-72ce-98db-663b44c0d924",
  "status": 404,
  "title": "Resource not found",
  "traceId": "b94f4db5-2f5e-4b8f-9dd0-f2fe5c7a7a4f",
  "type": "https://docs.immoteur.com/problems/resource_not_found"
}

Issue

Create an issue report

Report an observed problem with property or listing information, a listing status, or grouping. Use data for information to review, including the status facet; use status when selected listings should have an expected lifecycle status; use clustering to group or separate records; and use other for another problem.

Copy one matching example below and replace its synthetic UUIDs with IDs your credentials can access. Each example includes the required fields for that request.

Use Report an issue through the API to choose the right report and verify the IDs you selected.

Reports record the problem; they do not change a Property, a Classified, a listing status, or a grouping.

POST

issues

curl --request POST \
  --url https://api.immoteur.com/public/v1/issues \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "issueKind": "data",
  "propertyId": "019e5500-0000-7000-8000-000000000001",
  "issueFacets": [
    "price"
  ]
}
'

{
  "createdAt": "2023-11-07T05:31:56Z",
  "reportId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

{
  "code": "resource_not_found",
  "detail": "The requested resource could not be found.",
  "instance": "/public/v1/properties/019c12dc-339f-72ce-98db-663b44c0d924",
  "status": 404,
  "title": "Resource not found",
  "traceId": "b94f4db5-2f5e-4b8f-9dd0-f2fe5c7a7a4f",
  "type": "https://docs.immoteur.com/problems/resource_not_found"
}

{
  "code": "resource_not_found",
  "detail": "The requested resource could not be found.",
  "instance": "/public/v1/properties/019c12dc-339f-72ce-98db-663b44c0d924",
  "status": 404,
  "title": "Resource not found",
  "traceId": "b94f4db5-2f5e-4b8f-9dd0-f2fe5c7a7a4f",
  "type": "https://docs.immoteur.com/problems/resource_not_found"
}

{
  "code": "resource_not_found",
  "detail": "The requested resource could not be found.",
  "instance": "/public/v1/properties/019c12dc-339f-72ce-98db-663b44c0d924",
  "status": 404,
  "title": "Resource not found",
  "traceId": "b94f4db5-2f5e-4b8f-9dd0-f2fe5c7a7a4f",
  "type": "https://docs.immoteur.com/problems/resource_not_found"
}

{
  "message": "Data access (SIREN / SIRET / Department) not configured.",
  "configurationUrl": "https://immoteur.com/en/dashboard/billing#data-access",
  "documentationUrl": "https://docs.immoteur.com/pages/en/introduction"
}

{
  "code": "validation_error",
  "detail": "One or more request fields are invalid.",
  "instance": "/public/v1/properties/search",
  "status": 422,
  "title": "Validation error",
  "traceId": "4bdb0c23-53fc-4d14-a300-c63eb420ec5e",
  "type": "https://docs.immoteur.com/problems/validation_error",
  "violations": [
    {
      "code": "validation",
      "field": "id",
      "message": "The id field must be a valid UUID."
    }
  ]
}

{
  "code": "resource_not_found",
  "detail": "The requested resource could not be found.",
  "instance": "/public/v1/properties/019c12dc-339f-72ce-98db-663b44c0d924",
  "status": 404,
  "title": "Resource not found",
  "traceId": "b94f4db5-2f5e-4b8f-9dd0-f2fe5c7a7a4f",
  "type": "https://docs.immoteur.com/problems/resource_not_found"
}

{
  "code": "resource_not_found",
  "detail": "The requested resource could not be found.",
  "instance": "/public/v1/properties/019c12dc-339f-72ce-98db-663b44c0d924",
  "status": 404,
  "title": "Resource not found",
  "traceId": "b94f4db5-2f5e-4b8f-9dd0-f2fe5c7a7a4f",
  "type": "https://docs.immoteur.com/problems/resource_not_found"
}

Authorizations

Authorization

string

header

required

Send your Immoteur Personal Access Token in the Authorization header: Authorization: Bearer <token>

You can create and manage your Personal Access Tokens here: https://immoteur.com/dashboard/settings

Body

application/json

Report incorrect information on one Property. Set issueKind to data, then provide propertyId and issueFacets.

issueFacets

enum<string>[]

required

Fields to review with this data report, including status.

Minimum array length: 1

Fields that can be reported with data, including status.

Available options:

attributes,

contact,

description,

link,

location,

media,

other,

price,

publisher,

status

issueKind

enum<string>

required

Fixed value data; identifies a data issue report.

Available options:

data

propertyId

string<uuid>

required

Property whose information needs review.

Pattern: ^(?:(?:urn|URN):(?:uuid|UUID):)?[0-9a-fA-F]{8}-(?:[0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$(?![\s\S])

comment

string

Optional details for a data, status, or grouping report. Maximum length: 4,000 characters.

Maximum string length: 4000

Response

Issue report created

createdAt

string<date-time>

required

Timestamp when the issue report was created.

reportId

string<uuid>

required

Identifier of the stored issue report for later support correlation.

Start

API

Webhooks

OpenAPI reference

Create an issue report

Authorizations

Body

Response