Cancel Consultation

Cancel a requested or a confirmed appointment. Answers the lead, which has no live appointment any more, with the receipt of what the client was told.

post/api/v1/seller/consultations/{consultation_id}/cancel

Request

  • Base URL: https://trovastorage.it (the document declares no server; this is the origin it was published from)
  • URL: https://trovastorage.it/api/v1/seller/consultations/{consultation_id}/cancel
  • Auth: one of:
    • API key in header X-Access-Token
    • HTTP bearer

Path parameters

consultation_idstring uuid required

Response

Successful Response

idstring uuid required
created_atstring date-time required
statusstring required
site_idstring uuid nullable required
site_namestring nullable required
size_class_m2integer required
interpreted_size_class_m2integer required
overriddenboolean required
free_countinteger required
zero_resultsboolean required
contact_namestring nullable required
appointment_starts_atstring date-time nullable required
appointment_meeting_typestring nullable
appointment_statestring nullable
intentstring nullable
contact_preferencestring nullable
distribution_statestring
entered_by_adminboolean
size_knownboolean
recipient_idstring uuid nullable
statestring
unreadboolean
unread_messagesinteger
others_countinteger
directboolean
areastring nullable
offeredboolean
closed_reasonstring nullable
originstring
origin_detailstring nullable
moved_inboolean nullable
contact_releasedboolean
original_textstring required
interpretationobject required
resolved_atstring date-time required
radius_kmnumber required
featuresstring[] required
contact_emailstring nullable required
contact_phonestring nullable required
internal_notestring nullable required
transcriptobject[] required
size_class_optionsinteger[] required
other_operators_centresinteger
cancel_reasonstring nullable
can_respondboolean
can_declineboolean
can_messageboolean
can_mark_wonboolean
can_confirm_move_inboolean
thread_closedboolean
decline_reasonstring nullable

Changes

No recorded changes to this operation across all 1 revision of this API.