Chats

Flag a chat for a person

Raises or clears the flag that says this chat needs a person rather than the AI. It never stops the AI from reading the chat.

PUT

https://api.portal.magicdoor.com/company-app/chats/{chatId}/human-engagement

Authorization

Authorizationstringrequired

Bearer token — Send your API token in the Authorization header as Bearer <token>. Requests without a valid token are rejected with 401 Unauthorized.

Path parameters

chatIdstringrequired

The chat to flag.

example: 1830472847398404096

Body

application/json

requestedbooleanrequired

true raises the flag, false clears it.

example: true

Response

200 · The flag was set. The response has no body.

401 · The access token is missing, expired, or not valid.

404 · No chat with that id belongs to your company.

The AI raises this flag itself when it decides a conversation needs a person. The next message a property manager posts to the chat clears it automatically, so you rarely need to clear it by hand.

Request

curl --request PUT \
  --url 'https://api.portal.magicdoor.com/company-app/chats/1830472847398404096/human-engagement' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "requested": true
}'

Body

{
  "requested": true
}

Response

{
  "type": "https://httpstatuses.com/404",
  "title": "Not Found",
  "status": 404,
  "detail": "Chat 1830472847398404096 was not found",
  "traceId": "0HN7GK9C2M4PQ"
}