> ## 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. # Create complaint > Log a complaint at stage 1 (idempotent on requestId) ## OpenAPI ````yaml /openapi.json post /maintenance-pro/complaints 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: documents - name: compliance - name: activity - name: tasks - name: today - 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/complaints: post: tags: - maintenance-pro summary: Create complaint description: Log a complaint at stage 1 (idempotent on requestId) operationId: maintenance-pro.createComplaint parameters: [] requestBody: content: application/json: schema: type: object properties: requestId: type: string minLength: 1 complainantKind: type: string enum: - tenant - landlord - other contactId: anyOf: - type: string - type: 'null' complainantName: type: string complainantEmail: anyOf: - type: string - type: 'null' complainantPhone: anyOf: - type: string - type: 'null' propertyId: anyOf: - type: string - type: 'null' repairId: anyOf: - type: string - type: 'null' channel: type: string enum: - phone - email - letter - in_person - online - other category: type: string enum: - repairs - communication - staff_conduct - fees_charges - deposit - contractor - other summary: type: string outcomeSought: anyOf: - type: string - type: 'null' receivedOn: type: string handlerUserId: anyOf: - type: string - type: 'null' required: - requestId - complainantKind - contactId - complainantName - complainantEmail - complainantPhone - propertyId - repairId - channel - category - summary - outcomeSought - receivedOn - handlerUserId additionalProperties: false required: true responses: '200': description: Success content: application/json: schema: type: object properties: complaint: type: object properties: id: type: string reference: type: string status: type: string enum: - stage_1 - stage_2 - closed - withdrawn - not_accepted stage: type: number enum: - 1 - 2 complainantKind: type: string enum: - tenant - landlord - other complainantName: type: string complainantEmail: anyOf: - type: string - type: 'null' complainantPhone: anyOf: - type: string - type: 'null' contactId: anyOf: - type: string - type: 'null' propertyId: anyOf: - type: string - type: 'null' propertyLabel: anyOf: - type: string - type: 'null' repairId: anyOf: - type: string - type: 'null' repairReference: anyOf: - type: string - type: 'null' channel: type: string enum: - phone - email - letter - in_person - online - other category: type: string enum: - repairs - communication - staff_conduct - fees_charges - deposit - contractor - other summary: type: string outcomeSought: anyOf: - type: string - type: 'null' handlerUserId: anyOf: - type: string - type: 'null' handlerName: anyOf: - type: string - type: 'null' timings: type: object properties: scheme: type: string enum: - tpo - prs - housing_ombudsman - custom stage1: type: object properties: acknowledge: type: object properties: days: anyOf: - type: number - type: string enum: - Infinity - '-Infinity' - NaN source: type: string enum: - housing_ombudsman_code_2024 - tpo_scheme_rules - tpo_code_unverified - prs_scheme_rules - sortx_default - agency required: - days - source additionalProperties: false respond: type: object properties: days: anyOf: - type: number - type: string enum: - Infinity - '-Infinity' - NaN source: type: string enum: - housing_ombudsman_code_2024 - tpo_scheme_rules - tpo_code_unverified - prs_scheme_rules - sortx_default - agency required: - days - source additionalProperties: false respondFrom: type: string enum: - received - acknowledged extension: type: object properties: days: anyOf: - type: number - type: string enum: - Infinity - '-Infinity' - NaN source: type: string enum: - housing_ombudsman_code_2024 - tpo_scheme_rules - tpo_code_unverified - prs_scheme_rules - sortx_default - agency required: - days - source additionalProperties: false required: - acknowledge - respond - respondFrom - extension additionalProperties: false stage2: type: object properties: acknowledge: type: object properties: days: anyOf: - type: number - type: string enum: - Infinity - '-Infinity' - NaN source: type: string enum: - housing_ombudsman_code_2024 - tpo_scheme_rules - tpo_code_unverified - prs_scheme_rules - sortx_default - agency required: - days - source additionalProperties: false respond: type: object properties: days: anyOf: - type: number - type: string enum: - Infinity - '-Infinity' - NaN source: type: string enum: - housing_ombudsman_code_2024 - tpo_scheme_rules - tpo_code_unverified - prs_scheme_rules - sortx_default - agency required: - days - source additionalProperties: false respondFrom: type: string enum: - received - acknowledged extension: type: object properties: days: anyOf: - type: number - type: string enum: - Infinity - '-Infinity' - NaN source: type: string enum: - housing_ombudsman_code_2024 - tpo_scheme_rules - tpo_code_unverified - prs_scheme_rules - sortx_default - agency required: - days - source additionalProperties: false required: - acknowledge - respond - respondFrom - extension additionalProperties: false referralAfterDays: anyOf: - type: object properties: days: anyOf: - type: number - type: string enum: - Infinity - '-Infinity' - NaN source: type: string enum: - housing_ombudsman_code_2024 - tpo_scheme_rules - tpo_code_unverified - prs_scheme_rules - sortx_default - agency required: - days - source additionalProperties: false - type: 'null' required: - scheme - stage1 - stage2 - referralAfterDays additionalProperties: false stage1: type: object properties: stage: type: number enum: - 1 - 2 receivedOn: type: string acknowledgedOn: anyOf: - type: string - type: 'null' extensionDays: anyOf: - type: number - type: string enum: - Infinity - '-Infinity' - NaN extensionReason: anyOf: - type: string - type: 'null' respondedOn: anyOf: - type: string - type: 'null' decision: anyOf: - type: string enum: - upheld - partly_upheld - not_upheld - type: 'null' response: anyOf: - type: string - type: 'null' remedy: anyOf: - type: string - type: 'null' responderName: anyOf: - type: string - type: 'null' acknowledgeBy: type: object properties: due: type: string doneOn: anyOf: - type: string - type: 'null' state: type: string enum: - met - late - overdue - due_today - upcoming days: anyOf: - type: number - type: string enum: - Infinity - '-Infinity' - NaN source: type: string enum: - housing_ombudsman_code_2024 - tpo_scheme_rules - tpo_code_unverified - prs_scheme_rules - sortx_default - agency sourceLabel: type: string required: - due - doneOn - state - days - source - sourceLabel additionalProperties: false respondBy: type: object properties: due: type: string doneOn: anyOf: - type: string - type: 'null' state: type: string enum: - met - late - overdue - due_today - upcoming days: anyOf: - type: number - type: string enum: - Infinity - '-Infinity' - NaN source: type: string enum: - housing_ombudsman_code_2024 - tpo_scheme_rules - tpo_code_unverified - prs_scheme_rules - sortx_default - agency sourceLabel: type: string required: - due - doneOn - state - days - source - sourceLabel additionalProperties: false required: - stage - receivedOn - acknowledgedOn - extensionDays - extensionReason - respondedOn - decision - response - remedy - responderName - acknowledgeBy - respondBy additionalProperties: false stage2: anyOf: - type: object properties: stage: type: number enum: - 1 - 2 receivedOn: type: string acknowledgedOn: anyOf: - type: string - type: 'null' extensionDays: anyOf: - type: number - type: string enum: - Infinity - '-Infinity' - NaN extensionReason: anyOf: - type: string - type: 'null' respondedOn: anyOf: - type: string - type: 'null' decision: anyOf: - type: string enum: - upheld - partly_upheld - not_upheld - type: 'null' response: anyOf: - type: string - type: 'null' remedy: anyOf: - type: string - type: 'null' responderName: anyOf: - type: string - type: 'null' acknowledgeBy: type: object properties: due: type: string doneOn: anyOf: - type: string - type: 'null' state: type: string enum: - met - late - overdue - due_today - upcoming days: anyOf: - type: number - type: string enum: - Infinity - '-Infinity' - NaN source: type: string enum: - housing_ombudsman_code_2024 - tpo_scheme_rules - tpo_code_unverified - prs_scheme_rules - sortx_default - agency sourceLabel: type: string required: - due - doneOn - state - days - source - sourceLabel additionalProperties: false respondBy: type: object properties: due: type: string doneOn: anyOf: - type: string - type: 'null' state: type: string enum: - met - late - overdue - due_today - upcoming days: anyOf: - type: number - type: string enum: - Infinity - '-Infinity' - NaN source: type: string enum: - housing_ombudsman_code_2024 - tpo_scheme_rules - tpo_code_unverified - prs_scheme_rules - sortx_default - agency sourceLabel: type: string required: - due - doneOn - state - days - source - sourceLabel additionalProperties: false required: - stage - receivedOn - acknowledgedOn - extensionDays - extensionReason - respondedOn - decision - response - remedy - responderName - acknowledgeBy - respondBy additionalProperties: false - type: 'null' remedyAmountMinor: anyOf: - anyOf: - type: number - type: string enum: - Infinity - '-Infinity' - NaN - type: 'null' closedOn: anyOf: - type: string - type: 'null' closeNote: anyOf: - type: string - type: 'null' referral: type: object properties: scheme: anyOf: - type: string enum: - tpo - prs - housing_ombudsman - other - type: 'null' referredOn: anyOf: - type: string - type: 'null' reference: anyOf: - type: string - type: 'null' mayReferFrom: anyOf: - type: string - type: 'null' outcome: anyOf: - type: string enum: - upheld - partly_upheld - not_upheld - settled - withdrawn - type: 'null' outcomeOn: anyOf: - type: string - type: 'null' awardMinor: anyOf: - anyOf: - type: number - type: string enum: - Infinity - '-Infinity' - NaN - type: 'null' note: anyOf: - type: string - type: 'null' required: - scheme - referredOn - reference - mayReferFrom - outcome - outcomeOn - awardMinor - note additionalProperties: false attention: type: object properties: step: type: string enum: - acknowledge - respond - awaiting_complainant - none deadline: anyOf: - type: object properties: due: type: string doneOn: anyOf: - type: string - type: 'null' state: type: string enum: - met - late - overdue - due_today - upcoming days: anyOf: - type: number - type: string enum: - Infinity - '-Infinity' - NaN source: type: string enum: - housing_ombudsman_code_2024 - tpo_scheme_rules - tpo_code_unverified - prs_scheme_rules - sortx_default - agency sourceLabel: type: string required: - due - doneOn - state - days - source - sourceLabel additionalProperties: false - type: 'null' label: type: string required: - step - deadline - label additionalProperties: false sameResponderBothStages: type: boolean revision: anyOf: - type: number - type: string enum: - Infinity - '-Infinity' - NaN createdAt: type: string required: - id - reference - status - stage - complainantKind - complainantName - complainantEmail - complainantPhone - contactId - propertyId - propertyLabel - repairId - repairReference - channel - category - summary - outcomeSought - handlerUserId - handlerName - timings - stage1 - stage2 - remedyAmountMinor - closedOn - closeNote - referral - attention - sameResponderBothStages - revision - createdAt additionalProperties: false history: type: array items: type: object properties: action: type: string at: type: string actorName: anyOf: - type: string - type: 'null' note: anyOf: - type: string - type: 'null' required: - action - at - actorName - note additionalProperties: false today: type: string required: - complaint - history - today additionalProperties: false '400': description: >- TenantCreateRejected | ConfigMissing | IntegrationRejected | AuthRejected | RegistrationRejected | UnknownIntegration | WebhookUnroutable | RateUnavailable | ComplaintInvalid 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/ComplaintInvalidEncoded' '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 content: application/json: schema: $ref: '#/components/schemas/TenantSuspendedEncoded' '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/WorkspaceOwnerRequiredEncoded' '404': description: TenantNotFound | ModuleRequestNotFound | ComplaintNotFound content: application/json: schema: anyOf: - $ref: '#/components/schemas/TenantNotFoundEncoded' - $ref: '#/components/schemas/ModuleRequestNotFoundEncoded' - $ref: '#/components/schemas/ComplaintNotFoundEncoded' '409': description: >- WebhookDuplicate | RegistrationConflict | ComplaintConflict | MoneyBusy content: application/json: schema: anyOf: - $ref: '#/components/schemas/WebhookDuplicateEncoded' - $ref: '#/components/schemas/RegistrationConflictEncoded' - $ref: '#/components/schemas/ComplaintConflictEncoded' - $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: 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 ComplaintInvalidEncoded: type: object properties: _tag: type: string enum: - ComplaintInvalid 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 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 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 ComplaintNotFoundEncoded: type: object properties: _tag: type: string enum: - ComplaintNotFound id: type: string required: - _tag - 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 ComplaintConflictEncoded: type: object properties: _tag: type: string enum: - ComplaintConflict code: type: string enum: - stale - refused - request_reused 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.