> ## Documentation Index
> Fetch the complete documentation index at: https://docs.signalproptech.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Send a viewing

> Send it when it's booked, moved or cancelled, before it happens. Sending the same `external_id` again updates it. A viewing first heard of more than 2 hours after its start never triggers feedback.



## OpenAPI

````yaml /openapi.json post /viewings
openapi: 3.1.0
info:
  title: Signal Partner API
  description: >-
    Send Signal enquiries, viewings and listings from your system, and receive
    what Signal learns back as signed webhooks. Every call is in beta:
    documented ahead of going live, it answers `501 not_available_yet` until
    then.
  contact:
    name: Signal
    url: https://signalproptech.com/
  version: 1.0.0-beta
servers:
  - url: https://api.signalproptech.com/api/v1/partner
    description: Production
security: []
tags:
  - name: Enquiries
    description: >-
      Hand Signal an enquiry that started in your system, and read where it
      stands.
  - name: Viewings
    description: >-
      Tell Signal about viewings booked in your system, so it can remind and ask
      for feedback.
  - name: Listings and new homes
    description: >-
      Keep Signal's copy of your listings, developments, units and reservations
      up to date.
  - name: Webhooks
    description: >-
      Register where Signal sends events, test it, and catch up on what you
      missed.
  - name: Events
    description: >-
      What Signal sends to your webhook, one page per event type. Check the
      webhook- headers before trusting the body.
paths:
  /viewings:
    post:
      tags:
        - Viewings
      summary: Send a viewing
      description: >-
        Send it when it's booked, moved or cancelled, before it happens. Sending
        the same `external_id` again updates it. A viewing first heard of more
        than 2 hours after its start never triggers feedback.
      operationId: send_viewing
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ViewingIn'
        required: true
      responses:
        '200':
          description: Updated a viewing we already had.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ViewingRecorded'
        '201':
          description: Recorded. `feedback` says whether we'll ask for feedback.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ViewingRecorded'
        '401':
          description: The key is missing, unknown or revoked.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '413':
          description: The body is over 64 KB.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '415':
          description: The body is not JSON.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '422':
          description: Validation failed. `fields` lists each problem.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '429':
          description: Rate limited. Retry after the number of seconds in `Retry-After`.
          headers:
            Retry-After:
              description: Seconds to wait before retrying.
              schema:
                type: integer
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '501':
          description: Not live yet (beta).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
      security:
        - AgencyKey: []
components:
  schemas:
    ViewingIn:
      properties:
        external_id:
          type: string
          maxLength: 128
          minLength: 1
          title: External Id
          description: One per person per viewing.
        status:
          type: string
          enum:
            - booked
            - cancelled
            - no_show
            - completed
          title: Status
          description: >-
            booked: it's on (for a moved viewing, send booked with the new
            time). cancelled: it's off. no_show: they didn't come. completed: it
            went ahead.
        scheduled_at:
          type: string
          format: date-time
          title: Scheduled At
          description: When it starts, with an offset.
        duration_minutes:
          type: integer
          title: Duration Minutes
          description: Defaults to 30. A value outside 5 to 480 minutes is treated as 30.
          default: 30
        enquiry_external_id:
          anyOf:
            - type: string
              maxLength: 128
              minLength: 1
              description: >-
                Your own id. Stored and echoed back as sent, without surrounding
                spaces.
            - type: 'null'
          title: Enquiry External Id
          description: >-
            An enquiry you sent us. If you send more than one of
            enquiry_external_id, contact_id and contact, enquiry_external_id
            wins, then contact_id, then contact. An id we've never seen is
            skipped when the next one tells us who it is; it's a 422 only when
            nothing does.
        contact_id:
          anyOf:
            - type: string
              format: uuid
            - type: 'null'
          title: Contact Id
          description: Signal's id for the person, from any event or response.
        contact:
          anyOf:
            - $ref: '#/components/schemas/Contact'
            - type: 'null'
          description: 'When there''s no enquiry: phone required.'
        transaction_type:
          anyOf:
            - type: string
              enum:
                - sale
                - letting
            - type: 'null'
          title: Transaction Type
          description: Required when contact is the only way we can tell who it's for.
        property:
          $ref: '#/components/schemas/PropertyRef'
        negotiator:
          anyOf:
            - $ref: '#/components/schemas/Negotiator'
            - type: 'null'
          description: Shown to the agency's staff. Never to the viewer.
        updated_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Updated At
          description: >-
            When it last changed in your system. If you send it, an update older
            than the one we hold is ignored. Without it, the last call wins.
      type: object
      required:
        - external_id
        - status
        - scheduled_at
        - property
      title: ViewingIn
      description: A viewing booked, moved or cancelled in your system, for one person.
    ViewingRecorded:
      properties:
        viewing_id:
          type: string
          format: uuid
          title: Viewing Id
          description: Signal's id for the viewing.
        external_id:
          type: string
          title: External Id
          description: Your viewing id.
        feedback:
          type: string
          enum:
            - scheduled
            - not_scheduled
          title: Feedback
          description: >-
            scheduled: we'll ask for feedback after it. not_scheduled: we won't
            (see reason).
        reason:
          anyOf:
            - type: string
              enum:
                - too_late
                - cancelled
                - no_show
                - opted_out
                - no_consent
                - no_phone
                - not_mobile
                - transaction_type_off
                - whatsapp_not_connected
            - type: 'null'
          title: Reason
          description: >-
            Why no feedback will be asked for. too_late: we first heard of it
            more than 2 hours after its start. cancelled / no_show: it didn't go
            ahead. opted_out, no_consent, no_phone, not_mobile,
            transaction_type_off, whatsapp_not_connected: as for enquiries.
      type: object
      required:
        - viewing_id
        - external_id
        - feedback
      title: ViewingRecorded
      description: What Signal will do about a viewing you sent.
    ErrorBody:
      properties:
        error:
          type: string
          title: Error
          description: >-
            Stable machine code: validation_failed, unauthorized, bad_request,
            forbidden, not_found, method_not_allowed, conflict, too_large,
            unsupported_media_type, rate_limited, cursor_expired,
            not_available_yet or internal_error. Any other status gives error.
        message:
          type: string
          title: Message
          description: What went wrong, in plain English.
        request_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Request Id
          description: Quote this to us and we can find the call.
        fields:
          items:
            $ref: '#/components/schemas/FieldError'
          type: array
          title: Fields
          description: Each problem with the request. Empty for other errors.
      type: object
      required:
        - error
        - message
      title: ErrorBody
      description: Every error has this shape.
    Contact:
      properties:
        external_id:
          anyOf:
            - type: string
              maxLength: 128
              minLength: 1
              description: >-
                Your own id. Stored and echoed back as sent, without surrounding
                spaces.
            - type: 'null'
          title: External Id
          description: Your contact id.
        first_name:
          anyOf:
            - type: string
              maxLength: 200
              minLength: 1
            - type: 'null'
          title: First Name
          description: If you hold one name string, send it here.
        last_name:
          anyOf:
            - type: string
              maxLength: 200
              minLength: 1
            - type: 'null'
          title: Last Name
          description: Their surname, if you hold one.
        phone:
          anyOf:
            - type: string
              maxLength: 32
            - type: 'null'
          title: Phone
          description: >-
            Irish (+353) or UK (+44) numbers. National numbers (086 123 4567,
            07700 900123) are read for the agency's side of the border. Without
            a mobile number nothing can be sent, but the record is kept.
        email:
          anyOf:
            - type: string
            - type: 'null'
          title: Email
          description: >-
            Treated as absent, not refused, if we can't read it as an email
            address.
      type: object
      title: Contact
      description: A person, as your system holds them.
    PropertyRef:
      properties:
        ref:
          anyOf:
            - type: string
              maxLength: 128
              minLength: 1
              description: >-
                Your own id. Stored and echoed back as sent, without surrounding
                spaces.
            - type: 'null'
          title: Ref
          description: >-
            Your property or unit reference. For new homes, leave it out when
            the enquiry is about a development rather than one unit, and send
            `development` instead.
        address:
          anyOf:
            - type: string
              maxLength: 500
              minLength: 1
            - type: 'null'
          title: Address
          description: Names the property in messages. Recommended.
        development:
          anyOf:
            - $ref: '#/components/schemas/DevelopmentRef'
            - type: 'null'
          description: 'New homes: the development the unit is in.'
        details:
          anyOf:
            - $ref: '#/components/schemas/ListingDetails'
            - type: 'null'
          description: What you know about the property, if you want Signal to have it.
      type: object
      title: PropertyRef
      description: >-
        The property an enquiry or viewing is about: your reference, the
        development, or both.
    Negotiator:
      properties:
        name:
          anyOf:
            - type: string
              maxLength: 200
              minLength: 1
            - type: 'null'
          title: Name
          description: The negotiator's name.
        email:
          anyOf:
            - type: string
            - type: 'null'
          title: Email
          description: >-
            Treated as absent, not refused, if we can't read it as an email
            address.
      type: object
      title: Negotiator
      description: >-
        The negotiator handling a viewing. Shown to the agency's staff, never to
        the viewer.
    FieldError:
      properties:
        path:
          type: string
          title: Path
          description: >-
            Where the problem is, e.g. `contact.phone` or `house_types[0].name`.
            Empty for the request as a whole.
        code:
          type: string
          title: Code
          description: >-
            Stable code: required, empty, too_long, missing_offset, not_allowed,
            invalid_json or invalid.
        message:
          type: string
          title: Message
          description: What is wrong with this field, in plain English.
      type: object
      required:
        - path
        - code
        - message
      title: FieldError
      description: One problem with one field.
    DevelopmentRef:
      properties:
        ref:
          type: string
          maxLength: 128
          minLength: 1
          title: Ref
          description: >-
            Your development reference. Send the development first: an unknown
            one is a 422.
        name:
          anyOf:
            - type: string
              maxLength: 200
              minLength: 1
            - type: 'null'
          title: Name
          description: The development's name.
      type: object
      required:
        - ref
      title: DevelopmentRef
      description: A new-homes development, by your reference.
    ListingDetails:
      properties:
        price:
          anyOf:
            - $ref: '#/components/schemas/Price'
            - type: 'null'
          description: The asking price, or a letting's rent.
        bedrooms:
          anyOf:
            - type: integer
              maximum: 50
              minimum: 0
            - type: 'null'
          title: Bedrooms
          description: Number of bedrooms.
        bathrooms:
          anyOf:
            - type: integer
              maximum: 50
              minimum: 0
            - type: 'null'
          title: Bathrooms
          description: Number of bathrooms.
        property_type:
          anyOf:
            - type: string
              maxLength: 100
              minLength: 1
            - type: 'null'
          title: Property Type
          description: Free text.
        floor_area_sqm:
          anyOf:
            - type: number
              maximum: 100000
              exclusiveMinimum: 0
            - type: 'null'
          title: Floor Area Sqm
          description: Floor area in square metres.
        available_from:
          anyOf:
            - type: string
              format: date
            - type: 'null'
          title: Available From
          description: When it's free to move in.
        furnished:
          anyOf:
            - type: string
              enum:
                - furnished
                - part_furnished
                - unfurnished
            - type: 'null'
          title: Furnished
          description: furnished, part_furnished or unfurnished.
        pets_allowed:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Pets Allowed
          description: Whether pets are allowed.
        minimum_term_months:
          anyOf:
            - type: integer
              maximum: 120
              minimum: 1
            - type: 'null'
          title: Minimum Term Months
          description: The shortest tenancy offered, in months.
        deposit:
          anyOf:
            - $ref: '#/components/schemas/Money'
            - type: 'null'
          description: A letting's deposit.
      type: object
      title: ListingDetails
      description: >-
        What you know about the property. Every field is optional: send what you
        have.
    Price:
      properties:
        amount:
          type: integer
          minimum: 0
          title: Amount
          description: >-
            Minor units: €395,000 is 39500000. A decimal point is refused,
            because it usually means whole euros or pounds were sent.
        currency:
          type: string
          enum:
            - EUR
            - GBP
          title: Currency
          description: EUR or GBP.
        period:
          anyOf:
            - type: string
              enum:
                - week
                - month
            - type: 'null'
          title: Period
          description: Required on a letting listing's price.
      type: object
      required:
        - amount
        - currency
      title: Price
      description: A price. A letting's rent also says how often it's paid.
    Money:
      properties:
        amount:
          type: integer
          minimum: 0
          title: Amount
          description: >-
            Minor units: €395,000 is 39500000. A decimal point is refused,
            because it usually means whole euros or pounds were sent.
        currency:
          type: string
          enum:
            - EUR
            - GBP
          title: Currency
          description: EUR or GBP.
      type: object
      required:
        - amount
        - currency
      title: Money
      description: An amount in whole minor units (cents or pence).
  securitySchemes:
    AgencyKey:
      type: http
      description: >-
        The agency's secret key, sent as `Authorization: Bearer <key>`. One key
        per agency.
      scheme: bearer

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.