> ## 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 listing

> One resale or letting listing. Send it again whenever it changes.



## OpenAPI

````yaml /openapi.json post /listings
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:
  /listings:
    post:
      tags:
        - Listings and new homes
      summary: Send a listing
      description: One resale or letting listing. Send it again whenever it changes.
      operationId: send_listing
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListingIn'
        required: true
      responses:
        '200':
          description: >-
            Updated, or ignored because we already held a newer version (see
            `applied`).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListingSynced'
        '201':
          description: Recorded. `applied` says whether this version was used.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListingSynced'
        '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:
    ListingIn:
      properties:
        ref:
          type: string
          maxLength: 128
          minLength: 1
          title: Ref
          description: >-
            Your own id. Stored and echoed back as sent, without surrounding
            spaces.
        transaction_type:
          type: string
          enum:
            - sale
            - letting
          title: Transaction Type
          description: 'sale or letting: whether it''s for sale or to let.'
        status:
          type: string
          enum:
            - available
            - sale_agreed
            - sold
            - let_agreed
            - let
            - withdrawn
          title: Status
          description: >-
            available: on the market. sale_agreed / let_agreed: agreed but not
            completed. sold / let: completed. withdrawn: taken off the market.
            Anything but available stops Signal starting new conversations about
            it. Sales use sale_agreed / sold; lettings use let_agreed / let.
        address:
          type: string
          maxLength: 500
          minLength: 1
          title: Address
          description: The full address, as you'd show it to a buyer.
        postcode:
          anyOf:
            - type: string
            - type: 'null'
          title: Postcode
          description: >-
            The Eircode in Ireland, or the postcode. Treated as absent if it
            isn't 2 to 10 characters.
        branch_code:
          anyOf:
            - type: string
              maxLength: 32
              minLength: 1
            - type: 'null'
          title: Branch Code
          description: >-
            Which of the agency's branches it belongs to. The codes are agreed
            with the agency when they join. An unknown code is a 422.
        details:
          anyOf:
            - $ref: '#/components/schemas/ListingDetails'
            - type: 'null'
          description: What you know about the listing.
        portal_ids:
          anyOf:
            - $ref: '#/components/schemas/PortalIds'
            - type: 'null'
          description: >-
            Lets Signal match a portal enquiry to your listing, so events carry
            your ref.
        updated_at:
          type: string
          format: date-time
          title: Updated At
          description: >-
            When it last changed in your system (if you don't track that, send
            the time of the call). An update older than the one we hold is
            ignored; the same time again is applied, so retries are safe.
      type: object
      required:
        - ref
        - transaction_type
        - status
        - address
        - updated_at
      title: ListingIn
      description: >-
        One resale or letting listing, as your system holds it. Send the whole
        record each time: a field you leave out is cleared.
    ListingSynced:
      properties:
        ref:
          type: string
          title: Ref
          description: Your listing reference.
        status:
          type: string
          enum:
            - available
            - sale_agreed
            - sold
            - let_agreed
            - let
            - withdrawn
          title: Status
          description: The listing's status as recorded.
        applied:
          type: boolean
          title: Applied
          description: >-
            False when we already held a newer version (by updated_at), so this
            one was ignored.
      type: object
      required:
        - ref
        - status
        - applied
      title: ListingSynced
      description: What Signal did with a listing 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.
    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.
    PortalIds:
      properties:
        daft:
          anyOf:
            - type: string
              maxLength: 64
              minLength: 1
            - type: 'null'
          title: Daft
          description: The listing's id on Daft.
        myhome:
          anyOf:
            - type: string
              maxLength: 64
              minLength: 1
            - type: 'null'
          title: Myhome
          description: The listing's id on MyHome.
      type: object
      title: PortalIds
      description: >-
        The property's ids on the portals, so Signal can match a portal enquiry
        to your listing.
    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.
    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.