> ## 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. # Update preferences > Record consent, refusal, do-not-contact or a preferred channel at the revision read ## OpenAPI ````yaml /openapi.json put /contacts/{id}/preferences 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: /contacts/{id}/preferences: put: tags: - contacts summary: Update preferences description: >- Record consent, refusal, do-not-contact or a preferred channel at the revision read operationId: contacts.updatePreferences parameters: - name: id in: path schema: type: string required: true requestBody: content: application/json: schema: $ref: '#/components/schemas/ContactPreferencesUpdateBody' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ContactPreferencesRow' '400': description: >- TenantCreateRejected | ConfigMissing | IntegrationRejected | AuthRejected | RegistrationRejected | UnknownIntegration | WebhookUnroutable | RateUnavailable 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/ContactPreferencesInvalidError' '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 | WorkspaceOwnerRequired | WorkspaceRoleRequired 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/ContactIdentityForbiddenError' - $ref: '#/components/schemas/WorkspaceOwnerRequiredEncoded' - $ref: '#/components/schemas/WorkspaceRoleRequiredEncoded' '404': description: TenantNotFound | ModuleRequestNotFound content: application/json: schema: anyOf: - $ref: '#/components/schemas/TenantNotFoundEncoded' - $ref: '#/components/schemas/ModuleRequestNotFoundEncoded' - $ref: '#/components/schemas/ContactNotFound' '409': description: WebhookDuplicate | RegistrationConflict | MoneyBusy content: application/json: schema: anyOf: - $ref: '#/components/schemas/WebhookDuplicateEncoded' - $ref: '#/components/schemas/RegistrationConflictEncoded' - $ref: '#/components/schemas/ContactPreferencesStaleError' - $ref: '#/components/schemas/ContactRequestConflictError' - $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: ContactPreferencesUpdateBody: type: object properties: requestId: type: string expectedRevision: anyOf: - type: number - type: string enum: - Infinity - '-Infinity' - NaN preferredChannel: anyOf: - anyOf: - type: string - type: 'null' - type: 'null' doNotContact: anyOf: - type: object properties: set: type: boolean reason: type: string source: anyOf: - anyOf: - type: string - type: 'null' - type: 'null' required: - set - reason additionalProperties: false - type: 'null' permissions: anyOf: - type: array items: type: object properties: channel: type: string purpose: type: string status: type: string source: type: string evidence: anyOf: - anyOf: - type: string - type: 'null' - type: 'null' givenAt: anyOf: - anyOf: - type: string - type: 'null' - type: 'null' required: - channel - purpose - status - source additionalProperties: false - type: 'null' required: - requestId - expectedRevision additionalProperties: false ContactPreferencesRow: type: object properties: contactId: type: string preferredChannel: anyOf: - $ref: '#/components/schemas/ContactChannelSchema' - type: 'null' doNotContact: type: boolean doNotContactReason: anyOf: - type: string - type: 'null' doNotContactSource: anyOf: - type: string - type: 'null' doNotContactAt: anyOf: - type: string - type: 'null' doNotContactBy: anyOf: - anyOf: - type: object properties: kind: type: string enum: - user userId: type: string required: - kind - userId additionalProperties: false - type: object properties: kind: type: string enum: - api-key keyId: type: string keyName: type: string userId: type: string required: - kind - keyId - keyName - userId additionalProperties: false - type: object properties: kind: type: string enum: - system required: - kind additionalProperties: false - type: 'null' permissions: type: array items: $ref: '#/components/schemas/ChannelPermissionRow' revision: anyOf: - type: number - type: string enum: - Infinity - '-Infinity' - NaN updatedAt: anyOf: - type: string - type: 'null' required: - contactId - preferredChannel - doNotContact - doNotContactReason - doNotContactSource - doNotContactAt - doNotContactBy - permissions - revision - updatedAt 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 ContactPreferencesInvalidError: type: object properties: _tag: type: string enum: - ContactPreferencesInvalid field: type: string message: type: string required: - _tag - field - message 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 ContactIdentityForbiddenError: type: object properties: _tag: type: string enum: - ContactIdentityForbidden message: type: string required: - _tag - message additionalProperties: false WorkspaceOwnerRequiredEncoded: type: object properties: _tag: type: string enum: - WorkspaceOwnerRequired required: - _tag 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 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 ContactNotFound: type: object properties: _tag: type: string enum: - ContactNotFound 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 ContactPreferencesStaleError: type: object properties: _tag: type: string enum: - ContactPreferencesStale id: type: string expected: anyOf: - type: number - type: string enum: - Infinity - '-Infinity' - NaN actual: anyOf: - type: number - type: string enum: - Infinity - '-Infinity' - NaN message: type: string required: - _tag - id - expected - actual - message additionalProperties: false ContactRequestConflictError: type: object properties: _tag: type: string enum: - ContactRequestConflict kind: type: string message: type: string required: - _tag - kind - message 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 ContactChannelSchema: type: string enum: - email - sms - whatsapp - phone - post ChannelPermissionRow: type: object properties: channel: $ref: '#/components/schemas/ContactChannelSchema' purpose: $ref: '#/components/schemas/ConsentPurposeSchema' status: $ref: '#/components/schemas/PermissionStateSchema' source: anyOf: - type: string - type: 'null' evidence: anyOf: - type: string - type: 'null' givenAt: anyOf: - type: string - type: 'null' recordedAt: anyOf: - type: string - type: 'null' recordedBy: anyOf: - anyOf: - type: object properties: kind: type: string enum: - user userId: type: string required: - kind - userId additionalProperties: false - type: object properties: kind: type: string enum: - api-key keyId: type: string keyName: type: string userId: type: string required: - kind - keyId - keyName - userId additionalProperties: false - type: object properties: kind: type: string enum: - system required: - kind additionalProperties: false - type: 'null' required: - channel - purpose - status - source - evidence - givenAt - recordedAt - recordedBy additionalProperties: false ConsentPurposeSchema: type: string enum: - service - marketing PermissionStateSchema: type: string enum: - unknown - granted - refused 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.