Skip to content

Update a follow-up
Customers

Request

Updates a follow-up (e.g. rating). Requires SITE_CUSTOMER:WRITE permission.

Security
bearerAuth
Path
customerIdintegerrequired

ID of the customer.

Example:789
productIdintegerrequired

ID of the followed product.

Example:12345
Bodyapplication/jsonrequired
ratinginteger, [ 0 .. 5 ]

Customer interest rating for this product (0 = not rated, 1-5 scale).

Example:4
curl -i -X PATCH \
  https://api-doc.immo-facile.com/_mock/openapi/customers/789/follow-ups/12345 \
  -H 'Authorization: Bearer <YOUR_opaque_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "rating": 4
  }'

Responses

Follow-up updated

Bodyapplication/json
dataobject(FollowUpResponse)

A follow-up links a customer to a product they are interested in.

Response
{
  "data": {
    "customerId": 789,
    "productId": 12345,
    "opinion": { … },
    "rating": 4,
    "visibleCustomer": true,
    "updatedAt": "2019-08-24T14:15:22Z",
    "progress": "string"
  }
}