Passer au contenu principal
POST
/
issues
Create an issue report
curl --request POST \
  --url https://api.immoteur.com/public/v1/issues \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "propertyIds": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "issueKind": "clustering",
  "classifiedIds": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "clusteringAction": "merge",
  "comment": "<string>",
  "issueFacets": [
    "attributes"
  ]
}
'
{
  "createdAt": "2023-11-07T05:31:56Z",
  "reportId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

Autorisations

​
Authorization
string
header
requis

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 status: current: available

Corps

application/json

Public issue-report request. issueKind controls the conditional rules:

  • data requires at least one issueFacets value and cannot set clusteringAction
  • clustering requires clusteringAction and at least two explicit targets across propertyIds and classifiedIds
  • other requires a non-blank comment and cannot set issueFacets or clusteringAction

Provide at least one target overall through propertyIds or classifiedIds.

​
propertyIds
string<uuid>[]
requis

Explicit property targets identified by UUID.

Minimum array length: 1
​
issueKind
enum<string>
requis
Options disponibles:
clustering,
data,
other
​
classifiedIds
string<uuid>[]

Explicit classified targets identified by UUID.

​
clusteringAction
enum<string> | null

Required when issueKind is clustering.

Options disponibles:
merge,
split
​
comment
string

Optional details for data, required details for other, and optional details for clustering.

Maximum string length: 4000
​
issueFacets
enum<string>[]

Required when issueKind is data.

Minimum array length: 1
Options disponibles:
attributes,
contact,
description,
link,
location,
media,
other,
price,
publisher,
status

Réponse

Issue report created

​
createdAt
string<date-time>
requis

Timestamp when the issue report was created.

​
reportId
string<uuid>
requis

Identifier of the stored issue report for later support correlation.