> ## Documentation Index > Fetch the complete documentation index at: https://docs-v2.sortx.co.uk/llms.txt > Use this file to discover all available pages before exploring further. # Onboard property > Add a property from the New property wizard in one go: the property and its rooms, its owners, who repairs what, a repair authority draft and the occupiers' tenancies; optionally email the landlord a link to confirm the limits (idempotent on requestId) ## OpenAPI ````yaml /openapi.json post /maintenance-pro/properties/onboard openapi: 3.1.0 info: title: SortX API version: 1.0.0 description: >- Reactive repairs, planned maintenance, compliance and the repairs desk for UK letting agents and property managers. servers: - url: https://api.sortx.co.uk description: Production security: [] tags: - name: tenants - name: entitlements - name: events - name: workspace-settings - name: operational-catalogues - name: money - name: contacts - name: properties - name: address-lookup - name: tenancies - name: contractor-invoices - name: keys - name: inspections - name: handovers - name: planned-maintenance - name: contractors - name: company-onboarding - name: documents - name: compliance - name: activity - name: tasks - name: today - name: desk - name: people - name: property-boards - name: reports - name: workspace-search - name: calendar - name: telephony - name: maintenance-pro - name: front-desk - name: maintenance-pro-public - name: maintenance-pro-contractor paths: /maintenance-pro/properties/onboard: post: tags: - maintenance-pro summary: Onboard property description: >- Add a property from the New property wizard in one go: the property and its rooms, its owners, who repairs what, a repair authority draft and the occupiers' tenancies; optionally email the landlord a link to confirm the limits (idempotent on requestId) operationId: maintenance-pro.onboardProperty parameters: [] requestBody: content: application/json: schema: type: object properties: requestId: type: string maxLength: 200 address: type: object properties: line1: type: string maxLength: 200 line2: anyOf: - type: string maxLength: 200 - type: 'null' town: anyOf: - type: string maxLength: 120 - type: 'null' postcode: type: string maxLength: 16 uprn: anyOf: - type: string maxLength: 20 - type: 'null' required: - line1 - line2 - town - postcode - uprn additionalProperties: false type: type: string enum: - house - flat - maisonette - bungalow - hmo - studio - other letAs: type: string enum: - whole - rooms beds: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' furnishing: anyOf: - type: string enum: - unfurnished - part_furnished - furnished - type: 'null' occupierContactId: anyOf: - type: string - type: 'null' rooms: type: array items: type: object properties: name: type: string maxLength: 60 roomType: anyOf: - type: string enum: - single - double - en_suite - studio - type: 'null' furnishing: anyOf: - type: string enum: - unfurnished - part_furnished - furnished - type: 'null' occupierContactId: anyOf: - type: string - type: 'null' required: - name - roomType - furnishing - occupierContactId additionalProperties: false occupiedFrom: anyOf: - type: string - type: 'null' landlordContactId: anyOf: - type: string - type: 'null' landlordCompanyId: anyOf: - type: string - type: 'null' owners: type: array items: type: object properties: role: type: string enum: - co_owner - freeholder - head_lessor - managing_agent contactId: type: string interest: type: string enum: - freehold - leasehold - share_of_freehold - not_known sharePercent: anyOf: - anyOf: - type: number - type: string enum: - Infinity - '-Infinity' - NaN - type: 'null' fromOn: anyOf: - type: string - type: 'null' speaksForContactId: anyOf: - type: string - type: 'null' required: - role - contactId - interest - sharePercent - fromOn - speaksForContactId additionalProperties: false responsibilities: type: array items: $ref: '#/components/schemas/RepairResponsibility' repairAuthority: anyOf: - type: object properties: standardLimitPounds: anyOf: - type: number - type: string enum: - Infinity - '-Infinity' - NaN vatBasis: type: string enum: - inc_vat - ex_vat quotesAboveLimit: type: number enum: - 1 - 2 - 3 emergency: type: object properties: limitPounds: anyOf: - anyOf: - type: number - type: string enum: - Infinity - '-Infinity' - NaN - type: 'null' aboveLimit: type: string enum: - quote_to_owner - make_safe_then_quote required: - limitPounds - aboveLimit additionalProperties: false statutory: type: object properties: limitPounds: anyOf: - anyOf: - type: number - type: string enum: - Infinity - '-Infinity' - NaN - type: 'null' aboveLimit: type: string enum: - quote_to_owner - make_safe_then_quote required: - limitPounds - aboveLimit additionalProperties: false approverContactId: anyOf: - type: string - type: 'null' callRetryMinutes: anyOf: - type: number enum: - 15 - 30 - 60 - type: 'null' noAnswer: type: string enum: - escalate_to_staff - hold required: - standardLimitPounds - vatBasis - quotesAboveLimit - emergency - statutory - approverContactId - callRetryMinutes - noAnswer additionalProperties: false - type: 'null' emailLandlordToConfirm: type: boolean required: - requestId - address - type - letAs - beds - furnishing - occupierContactId - rooms - occupiedFrom - landlordContactId - landlordCompanyId - owners - responsibilities - repairAuthority - emailLandlordToConfirm additionalProperties: false required: true responses: '200': description: Success content: application/json: schema: type: object properties: propertyId: type: string units: type: array items: type: object properties: id: type: string label: type: string roomType: anyOf: - type: string enum: - single - double - en_suite - studio - type: 'null' furnishing: anyOf: - type: string enum: - unfurnished - part_furnished - furnished - type: 'null' tenancyId: anyOf: - type: string - type: 'null' required: - id - label - roomType - furnishing - tenancyId additionalProperties: false setupRevision: anyOf: - type: number - type: string enum: - Infinity - '-Infinity' - NaN repairAuthority: anyOf: - type: object properties: authorityId: type: string versionId: type: string revision: anyOf: - type: number - type: string enum: - Infinity - '-Infinity' - NaN summary: type: array items: type: string required: - authorityId - versionId - revision - summary additionalProperties: false - type: 'null' confirmation: type: object properties: requested: type: boolean sent: type: boolean sentTo: anyOf: - type: string - type: 'null' landlordName: anyOf: - type: string - type: 'null' expiresAt: anyOf: - type: string - type: 'null' reason: anyOf: - type: string - type: 'null' required: - requested - sent - sentTo - landlordName - expiresAt - reason additionalProperties: false replayed: type: boolean required: - propertyId - units - setupRevision - repairAuthority - confirmation - replayed additionalProperties: false '400': description: >- TenantCreateRejected | ConfigMissing | IntegrationRejected | AuthRejected | RegistrationRejected | UnknownIntegration | WebhookUnroutable | RateUnavailable | PropertyOnboardingInvalid | RepairAuthorityInvalid content: application/json: schema: anyOf: - $ref: '#/components/schemas/TenantCreateRejectedEncoded' - $ref: '#/components/schemas/ConfigMissingEncoded' - $ref: '#/components/schemas/IntegrationRejectedEncoded' - $ref: '#/components/schemas/AuthRejectedEncoded' - $ref: '#/components/schemas/RegistrationRejectedEncoded' - $ref: '#/components/schemas/UnknownIntegrationEncoded' - $ref: '#/components/schemas/WebhookUnroutableEncoded' - $ref: '#/components/schemas/RateUnavailableEncoded' - $ref: '#/components/schemas/PropertyOnboardingInvalidEncoded' - $ref: '#/components/schemas/RepairAuthorityInvalidEncoded' '401': description: Unauthenticated | WebhookRejected | ApiKeyRejected content: application/json: schema: anyOf: - $ref: '#/components/schemas/UnauthenticatedEncoded' - $ref: '#/components/schemas/WebhookRejectedEncoded' - $ref: '#/components/schemas/ApiKeyRejectedEncoded' '402': description: TenantSuspended | PlanRequired content: application/json: schema: anyOf: - $ref: '#/components/schemas/TenantSuspendedEncoded' - $ref: '#/components/schemas/PlanRequiredEncoded' '403': description: >- EntitlementMissing | NotAMember | ScopeUnknown | ScopeMissing | TenantMismatch | WorkspaceRoleRequired | WorkspaceOwnerRequired content: application/json: schema: anyOf: - $ref: '#/components/schemas/EntitlementMissingEncoded' - $ref: '#/components/schemas/NotAMemberEncoded' - $ref: '#/components/schemas/ScopeUnknownEncoded' - $ref: '#/components/schemas/ScopeMissingEncoded' - $ref: '#/components/schemas/TenantMismatchEncoded' - $ref: '#/components/schemas/WorkspaceRoleRequiredEncoded' - $ref: '#/components/schemas/PortfolioForbiddenError' - $ref: '#/components/schemas/WorkspaceOwnerRequiredEncoded' '404': description: TenantNotFound | ModuleRequestNotFound | RepairAuthorityNotFound content: application/json: schema: anyOf: - $ref: '#/components/schemas/TenantNotFoundEncoded' - $ref: '#/components/schemas/ModuleRequestNotFoundEncoded' - $ref: '#/components/schemas/RepairAuthorityNotFoundEncoded' '409': description: >- WebhookDuplicate | RegistrationConflict | PropertyOnboardingConflict | RepairAuthorityConflict | MoneyBusy content: application/json: schema: anyOf: - $ref: '#/components/schemas/WebhookDuplicateEncoded' - $ref: '#/components/schemas/RegistrationConflictEncoded' - $ref: '#/components/schemas/PropertyOnboardingConflictEncoded' - $ref: '#/components/schemas/RepairAuthorityConflictEncoded' - $ref: '#/components/schemas/MoneyBusyEncoded' '429': description: RateLimited content: application/json: schema: $ref: '#/components/schemas/RateLimitedEncoded' '503': description: IntegrationUnavailable content: application/json: schema: $ref: '#/components/schemas/IntegrationUnavailableEncoded' security: - apiKey: [] components: schemas: RepairResponsibility: type: object properties: part: type: string enum: - inside - heating - structure - communal - outside_space - occupier_damage responsible: type: string enum: - landlord - freeholder - managing_agent - occupier - agency - other otherName: anyOf: - type: string - type: 'null' instructs: type: string enum: - agency - responsible_party pays: type: string enum: - landlord - service_charge - occupier - freeholder required: - part - responsible - instructs - pays additionalProperties: false TenantCreateRejectedEncoded: type: object properties: _tag: type: string enum: - TenantCreateRejected reason: type: string field: anyOf: - type: string - type: 'null' required: - _tag - reason additionalProperties: false ConfigMissingEncoded: type: object properties: _tag: type: string enum: - ConfigMissing key: type: string required: - _tag - key additionalProperties: false IntegrationRejectedEncoded: type: object properties: _tag: type: string enum: - IntegrationRejected integration: type: string reason: type: string required: - _tag - integration - reason additionalProperties: false AuthRejectedEncoded: type: object properties: _tag: type: string enum: - AuthRejected code: type: string message: type: string required: - _tag - code - message additionalProperties: false RegistrationRejectedEncoded: type: object properties: _tag: type: string enum: - RegistrationRejected message: type: string field: anyOf: - type: string - type: 'null' required: - _tag - message additionalProperties: false UnknownIntegrationEncoded: type: object properties: _tag: type: string enum: - UnknownIntegration integration: type: string required: - _tag - integration additionalProperties: false WebhookUnroutableEncoded: type: object properties: _tag: type: string enum: - WebhookUnroutable integration: type: string reason: type: string required: - _tag - integration - reason additionalProperties: false RateUnavailableEncoded: type: object properties: _tag: type: string enum: - RateUnavailable base: type: string quote: type: string 'on': type: string required: - _tag - base - quote - 'on' additionalProperties: false PropertyOnboardingInvalidEncoded: type: object properties: _tag: type: string enum: - PropertyOnboardingInvalid step: type: string enum: - request - property - rooms - owners - repairs - limits - occupiers field: type: string reason: type: string required: - _tag - step - field - reason additionalProperties: false RepairAuthorityInvalidEncoded: type: object properties: _tag: type: string enum: - RepairAuthorityInvalid field: type: string reason: type: string required: - _tag - field - reason additionalProperties: false UnauthenticatedEncoded: type: object properties: _tag: type: string enum: - Unauthenticated required: - _tag additionalProperties: false WebhookRejectedEncoded: type: object properties: _tag: type: string enum: - WebhookRejected integration: type: string reason: type: string required: - _tag - integration - reason additionalProperties: false ApiKeyRejectedEncoded: type: object properties: _tag: type: string enum: - ApiKeyRejected required: - _tag additionalProperties: false TenantSuspendedEncoded: type: object properties: _tag: type: string enum: - TenantSuspended tenantId: type: string reason: type: string required: - _tag - tenantId - reason additionalProperties: false PlanRequiredEncoded: type: object properties: _tag: type: string enum: - PlanRequired tenantId: type: string required: - _tag - tenantId additionalProperties: false EntitlementMissingEncoded: type: object properties: _tag: type: string enum: - EntitlementMissing tenantId: type: string moduleId: type: string required: - _tag - tenantId - moduleId additionalProperties: false NotAMemberEncoded: type: object properties: _tag: type: string enum: - NotAMember userId: type: string slug: type: string required: - _tag - userId - slug additionalProperties: false ScopeUnknownEncoded: type: object properties: _tag: type: string enum: - ScopeUnknown scope: type: string required: - _tag - scope additionalProperties: false ScopeMissingEncoded: type: object properties: _tag: type: string enum: - ScopeMissing scope: type: string required: - _tag - scope additionalProperties: false TenantMismatchEncoded: type: object properties: _tag: type: string enum: - TenantMismatch header: type: string organizationId: type: string required: - _tag - header - organizationId additionalProperties: false WorkspaceRoleRequiredEncoded: type: object properties: _tag: type: string enum: - WorkspaceRoleRequired role: anyOf: - type: string - type: 'null' required: type: array items: type: string message: type: string required: - _tag - role - required - message additionalProperties: false PortfolioForbiddenError: type: object properties: _tag: type: string enum: - PortfolioForbidden message: type: string required: - _tag - message additionalProperties: false WorkspaceOwnerRequiredEncoded: type: object properties: _tag: type: string enum: - WorkspaceOwnerRequired required: - _tag additionalProperties: false TenantNotFoundEncoded: type: object properties: _tag: type: string enum: - TenantNotFound slug: type: string required: - _tag - slug additionalProperties: false ModuleRequestNotFoundEncoded: type: object properties: _tag: type: string enum: - ModuleRequestNotFound id: type: string required: - _tag - id additionalProperties: false RepairAuthorityNotFoundEncoded: type: object properties: _tag: type: string enum: - RepairAuthorityNotFound resource: type: string id: type: string required: - _tag - resource - id additionalProperties: false WebhookDuplicateEncoded: type: object properties: _tag: type: string enum: - WebhookDuplicate integration: type: string externalId: type: string required: - _tag - integration - externalId additionalProperties: false RegistrationConflictEncoded: type: object properties: _tag: type: string enum: - RegistrationConflict message: type: string field: anyOf: - type: string - type: 'null' required: - _tag - message additionalProperties: false PropertyOnboardingConflictEncoded: type: object properties: _tag: type: string enum: - PropertyOnboardingConflict code: type: string enum: - request_reused - occupied reason: type: string required: - _tag - code - reason additionalProperties: false RepairAuthorityConflictEncoded: type: object properties: _tag: type: string enum: - RepairAuthorityConflict code: type: string enum: - stale - request_reused - not_draft - scope_refused - no_landlord - no_email - cannot_email reason: type: string revision: anyOf: - anyOf: - type: number - type: string enum: - Infinity - '-Infinity' - NaN - type: 'null' required: - _tag - code - reason - revision additionalProperties: false MoneyBusyEncoded: type: object properties: _tag: type: string enum: - MoneyBusy message: type: string required: - _tag - message additionalProperties: false RateLimitedEncoded: type: object properties: _tag: type: string enum: - RateLimited key: type: string retryAfterSeconds: anyOf: - type: number - type: string enum: - Infinity - '-Infinity' - NaN message: type: string required: - _tag - key - retryAfterSeconds - message additionalProperties: false IntegrationUnavailableEncoded: type: object properties: _tag: type: string enum: - IntegrationUnavailable integration: type: string detail: anyOf: - type: string - type: 'null' required: - _tag - integration additionalProperties: false securitySchemes: apiKey: type: apiKey in: header name: x-api-key description: >- A workspace API key (Settings → API keys), scoped to `:read` / `:write`. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.