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

> A new-homes development and its house types. Send it before its units.



## OpenAPI

````yaml /openapi.json post /developments
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:
  /developments:
    post:
      tags:
        - Listings and new homes
      summary: Send a development
      description: A new-homes development and its house types. Send it before its units.
      operationId: send_development
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DevelopmentIn'
        required: true
      responses:
        '200':
          description: >-
            Updated, or ignored because we already held a newer version (see
            `applied`).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DevelopmentSynced'
        '201':
          description: Recorded. `applied` says whether this version was used.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DevelopmentSynced'
        '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:
    DevelopmentIn:
      properties:
        ref:
          type: string
          maxLength: 128
          minLength: 1
          title: Ref
          description: >-
            Your own id. Stored and echoed back as sent, without surrounding
            spaces.
        name:
          type: string
          maxLength: 200
          minLength: 1
          title: Name
          description: The development's marketing name.
        address:
          type: string
          maxLength: 500
          minLength: 1
          title: Address
          description: Where it is, as you'd show it to a buyer.
        status:
          type: string
          enum:
            - pre_launch
            - on_sale
            - final_phase
            - sold_out
            - completing
          title: Status
          description: >-
            pre_launch: not yet selling. on_sale: selling. final_phase: last
            units. sold_out: nothing left. completing: sales closing out.
        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.
        house_types:
          items:
            $ref: '#/components/schemas/HouseType'
          type: array
          maxItems: 100
          title: House Types
          description: >-
            The full list each time. A house type you leave out is removed.
            Types are matched by name, so renaming one is a removal plus an
            addition.
        portal_ids:
          anyOf:
            - $ref: '#/components/schemas/PortalIds'
            - type: 'null'
          description: The development's ids on the portals.
        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
        - name
        - address
        - status
        - updated_at
      title: DevelopmentIn
      description: >-
        A new-homes development and its house types. Send the whole record each
        time: a field you leave out is cleared.
    DevelopmentSynced:
      properties:
        ref:
          type: string
          title: Ref
          description: Your development reference.
        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
        - applied
      title: DevelopmentSynced
      description: What Signal did with a development 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.
    HouseType:
      properties:
        name:
          type: string
          maxLength: 100
          minLength: 1
          title: Name
          description: The house type's name, e.g. The Alder.
        bedrooms:
          anyOf:
            - type: integer
              maximum: 50
              minimum: 0
            - type: 'null'
          title: Bedrooms
          description: Number of bedrooms.
        image_url:
          anyOf:
            - type: string
            - type: 'null'
          title: Image Url
          description: >-
            Treated as absent, not refused, if we can't read it as a web
            address. Use https: an http image may not display.
        floor_plan_url:
          anyOf:
            - type: string
            - type: 'null'
          title: Floor Plan Url
          description: >-
            Treated as absent, not refused, if we can't read it as a web
            address. Use https: an http image may not display.
      type: object
      required:
        - name
      title: HouseType
      description: A house type in a development.
    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.
  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.