Make Visible

cURL

curl --request PUT \
  --url http://sandbox.mintlify.com/integration/visit/{id}/make-visible

{
  "id": 123,
  "visitType": "EXPRESS",
  "status": "requested",
  "acceptableBy": "ALL",
  "acceptableByAgentGroup": {
    "id": "<string>",
    "name": "<string>"
  },
  "acceptableByAgentGroupDeadline": "2023-11-07T05:31:56Z",
  "isHidden": false,
  "propertyCode": "<string>",
  "visitorName": "<string>",
  "visitorEmail": "[email protected]",
  "visitorPhone": "<string>",
  "createdByUserEmail": "[email protected]",
  "responsibleUserEmail": "[email protected]",
  "responsibleAgency": {
    "id": "<string>",
    "name": "<string>"
  },
  "scheduledAt": "2023-11-07T05:31:56Z",
  "briefing": "<string>",
  "keyLocation": "AGENCY",
  "keyLocationAddress": {
    "streetAddress": "<string>",
    "streetNumber": "<string>",
    "neighborhood": "<string>",
    "zipCode": "<string>",
    "locality": "<string>",
    "state": "<string>",
    "country": "<string>",
    "complement": "<string>",
    "latitude": 0,
    "longitude": 0
  },
  "companionType": "NONE",
  "companionName": "<string>",
  "companionWhatsappNumber": "<string>",
  "scheduleSourceInputData": {
    "sourceVisitId": "<string>",
    "webhooks": [
      "<string>"
    ],
    "customData": {}
  },
  "cancelReason": {
    "cancelReasonId": 2,
    "cancelReasonName": "<string>",
    "cancelReasonSlug": "<string>",
    "cancelReasonNotes": "<string>"
  },
  "agentVisitNotes": "<string>",
  "agentEvaluationUrl": "<string>",
  "agentEvaluationFormResponse": {
    "items": [
      {
        "question": {
          "name": "<string>",
          "title": "<string>"
        },
        "answer": "<string>"
      }
    ]
  },
  "visitorEvaluationUrl": "<string>",
  "visitorVisitNotes": "<string>",
  "visitorNps": 123,
  "agentEmail": "[email protected]",
  "rescheduleFromVisitId": 123,
  "rescheduleToVisitId": 123,
  "agentName": "<string>",
  "agentPhone": "<string>"
}

PUT

integration

visit

{id}

make-visible

cURL

curl --request PUT \
  --url http://sandbox.mintlify.com/integration/visit/{id}/make-visible

{
  "id": 123,
  "visitType": "EXPRESS",
  "status": "requested",
  "acceptableBy": "ALL",
  "acceptableByAgentGroup": {
    "id": "<string>",
    "name": "<string>"
  },
  "acceptableByAgentGroupDeadline": "2023-11-07T05:31:56Z",
  "isHidden": false,
  "propertyCode": "<string>",
  "visitorName": "<string>",
  "visitorEmail": "[email protected]",
  "visitorPhone": "<string>",
  "createdByUserEmail": "[email protected]",
  "responsibleUserEmail": "[email protected]",
  "responsibleAgency": {
    "id": "<string>",
    "name": "<string>"
  },
  "scheduledAt": "2023-11-07T05:31:56Z",
  "briefing": "<string>",
  "keyLocation": "AGENCY",
  "keyLocationAddress": {
    "streetAddress": "<string>",
    "streetNumber": "<string>",
    "neighborhood": "<string>",
    "zipCode": "<string>",
    "locality": "<string>",
    "state": "<string>",
    "country": "<string>",
    "complement": "<string>",
    "latitude": 0,
    "longitude": 0
  },
  "companionType": "NONE",
  "companionName": "<string>",
  "companionWhatsappNumber": "<string>",
  "scheduleSourceInputData": {
    "sourceVisitId": "<string>",
    "webhooks": [
      "<string>"
    ],
    "customData": {}
  },
  "cancelReason": {
    "cancelReasonId": 2,
    "cancelReasonName": "<string>",
    "cancelReasonSlug": "<string>",
    "cancelReasonNotes": "<string>"
  },
  "agentVisitNotes": "<string>",
  "agentEvaluationUrl": "<string>",
  "agentEvaluationFormResponse": {
    "items": [
      {
        "question": {
          "name": "<string>",
          "title": "<string>"
        },
        "answer": "<string>"
      }
    ]
  },
  "visitorEvaluationUrl": "<string>",
  "visitorVisitNotes": "<string>",
  "visitorNps": 123,
  "agentEmail": "[email protected]",
  "rescheduleFromVisitId": 123,
  "rescheduleToVisitId": 123,
  "agentName": "<string>",
  "agentPhone": "<string>"
}

Path Parameters

number

required

Response

number

required

ID da visita na Visitown

visitType

enum<string>

required

Tipo da visita

Available options:

EXPRESS,

INSPECTION_OCCUPATION,

INSPECTION_PRE_AD,

INSPECTION_VACANCY,

LOCAL,

REMOTE

status

enum<string>

required

Status da visita

Available options:

requested,

accepted,

arrived,

started,

finished,

canceled

acceptableBy

enum<string>

required

Quem poderá aceitar essa visita

Available options:

ALL,

SUBSCRIBER_AGENTS_ONLY,

VISITOWNERS_ONLY

acceptableByAgentGroup

object

required

Grupo de demonstradores que tem preferência de aceite desta visita

Show child attributes

acceptableByAgentGroup.id

string

required

ID do grupo preferencial de demonstradores (na Visitown)

acceptableByAgentGroup.name

string

required

Nome do grupo preferencial de demonstradores

acceptableByAgentGroupDeadline

string<date-time>

required

Data/Hora limite para o grupo de demonstradores preferencial aceitar estar esta visita

isHidden

boolean

default:false

required

Se a visita não será listada no app, para aceite. Valor padrão: false. A visita ficará visivel, automaticamente, 1h antes do horário agendado (para visitas com demonstradores internos), 2h antes do horário agendado (para visitas com visitowners) ou a qualquer tempo, chamando-se o enpoint /integration/visits/:id/make-visible

propertyCode

string

required

Referência do imóvel

visitorName

string

required

Nome do visitante

visitorEmail

string<email>

required

Email do visitante

visitorPhone

string<E.164>

required

Telefone (whatsapp) do visitante

createdByUserEmail

string<email>

required

Email do usuário que agendou a visita

responsibleUserEmail

string<email>

required

Email do consultor/corretor responsável pela visita

responsibleAgency

object

required

Agência responsável pela visita

Show child attributes

responsibleAgency.id

string

required

ID da agência responsável (na Visitown)

responsibleAgency.name

string

required

Nome da agência responsável

scheduledAt

string<date-time>

required

Data/Hora da visita

briefing

string

required

Instruções da visita. Por exemplo: orientações sobre horário de retirada e devolução das chaves, se há necessidade de retirar carta de autorização, etc

keyLocation

enum<string>

required

Local de retirada das chaves

Available options:

AGENCY,

MASTER_KEY,

NONE,

OTHER,

PROPERTY

keyLocationAddress

object

required

Endereço do local de retirada das chaves

Show child attributes

keyLocationAddress.streetAddress

string

required

Logradouro

keyLocationAddress.streetNumber

string

required

Número do imóvel

keyLocationAddress.neighborhood

string

required

Nome do bairro

keyLocationAddress.zipCode

string

required

CEP

keyLocationAddress.locality

string

required

Nome do município

keyLocationAddress.state

string

required

Required string length: 2

keyLocationAddress.country

string

required

Sigla do país

Required string length: 2

keyLocationAddress.complement

string

Complemento

keyLocationAddress.latitude

number

Latitude

Required range: -90 <= x <= 90

keyLocationAddress.longitude

number

Longitude

Required range: -180 <= x <= 180

companionType

enum<string>

required

Tipo de acompanhante da visita.

Available options:

NONE,

OTHER,

OWNER

companionName

string

required

Nome do acompanhante da visita

companionWhatsappNumber

string<E.164>

required

Telefone (whatsapp) do acompanhante da visita

scheduleSourceInputData

object

required

Dados de entrada do agendamento via parceiro

Show child attributes

scheduleSourceInputData.sourceVisitId

string

required

Id da visita no sistema do parceiro

scheduleSourceInputData.webhooks

string<url>[]

required

Lista de urls para as quais serão disparados webhooks dos eventos dessa visita

scheduleSourceInputData.customData

object

Dados customizados a serem enviados no payload dos webhooks dessa visita

cancelReason

object

required

Motivo do cancelamento da visita

Show child attributes

cancelReason.cancelReasonId

number

required

Id do motivo de cancelamento

Required range: x >= 1

cancelReason.cancelReasonName

string

required

Nome (internacionalizado) do motivo de cancelamento

cancelReason.cancelReasonSlug

string

required

Slug do motivo de cancelamento

cancelReason.cancelReasonNotes

string

required

Observações sobre o cancelamento

agentVisitNotes

string

required

Feedback dado pelo demonstrador

agentEvaluationUrl

string

required

Url para o relatório de avaliação da visita (versão Demonstrador)

agentEvaluationFormResponse

object

required

Respostas dadas pelo demonstrador, no formulário de avaliação da visita

Show child attributes

agentEvaluationFormResponse.items

object[]

required

Respostas dadas pelo demonstrador, no formulário de avaliação da visita

Show child attributes

agentEvaluationFormResponse.items.question

object

required

Dados da pergunta

Show child attributes

agentEvaluationFormResponse.items.question.name

string

required

Identificador único da pergunta

agentEvaluationFormResponse.items.question.title

string

required

Título ou texto da pergunta

agentEvaluationFormResponse.items.answer

string

required

Conteúdo da resposta

visitorEvaluationUrl

string

required

Url para o relatório de avaliação da visita (versão Visitante)

visitorVisitNotes

string

required

Feedback dado pelo cliente/visitante

visitorNps

number

required

NPS dado pelo cliente/demonstrador ao serviço prestado

agentEmail

string<email>

Email do demonstrador. Se houver um vinculado à visita.

rescheduleFromVisitId

number

Indica que esta visita é um reagendamento de outra (anterior), com ID indicado neste campo

rescheduleToVisitId

number

Indica que esta visita foi reagendada para outra, com ID indicado neste campo

agentName

string

Nome do demonstrador. Se houver um vinculado à visita.

agentPhone

string<E.164>

Telefone (whatsapp) do demonstrador. Se houver um vinculado à visita

Delete Plant

⌘I

API Documentation

Endpoint Examples

Visitas

Path Parameters

Response