Purplebricks

Purplebricks Marketing Preferences API

The MarketingPreferences API from Purplebricks — 2 operation(s) for marketingpreferences.

GitHub OpenAPI

Operations 2

GET /v1/marketingpreferences/{publicUserId}
PUT /v1/marketingpreferences

Documentation

📖
APIReference
https://api.purplebricks.co.uk/property-api/swagger/index.html
📖
Authentication
https://raw.githubusercontent.com/api-evangelist/purplebricks/refs/heads/main/authentication/purplebricks-authentication.yml
📖
APIReference
https://api.purplebricks.co.uk/account-api/swagger/index.html
📖
APIReference
https://api.purplebricks.co.uk/valuations-api/swagger/index.html
📖
APIReference
https://api.purplebricks.co.uk/viewings-api/swagger/index.html
📖
APIReference
https://api.purplebricks.co.uk/messaging-api/swagger/index.html
📖
APIReference
https://api.purplebricks.co.uk/lettings-api/swagger/index.html
📖
APIReference
https://api.purplebricks.co.uk/branch-api/swagger/index.html
📖
APIReference
https://api.purplebricks.co.uk/communications-api/swagger/index.html
📖
APIReference
https://api.purplebricks.co.uk/conveyancing-api/swagger/index.html
📖
APIReference
https://api.purplebricks.co.uk/agent-api/swagger/index.html
📖
APIReference
https://api.purplebricks.co.uk/feedback-api/swagger/index.html
📖
APIReference
https://api.purplebricks.co.uk/workflow-api/swagger/index.html
📖
APIReference
https://api.purplebricks.co.uk/outlook-api/swagger/index.html

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/purplebricks/refs/heads/main/openapi/purplebricks-marketingpreferences-api-openapi.yml

Other Resources

🔗
SwaggerUI
https://api.purplebricks.co.uk/property-api/swagger/index.html
🔗
Conventions
https://raw.githubusercontent.com/api-evangelist/purplebricks/refs/heads/main/conventions/purplebricks-conventions.yml
🔗
ErrorCatalog
https://raw.githubusercontent.com/api-evangelist/purplebricks/refs/heads/main/errors/purplebricks-problem-types.yml
🔗
SwaggerUI
https://api.purplebricks.co.uk/account-api/swagger/index.html
🔗
SwaggerUI
https://api.purplebricks.co.uk/valuations-api/swagger/index.html
🔗
SwaggerUI
https://api.purplebricks.co.uk/viewings-api/swagger/index.html
🔗
SwaggerUI
https://api.purplebricks.co.uk/messaging-api/swagger/index.html
🔗
SwaggerUI
https://api.purplebricks.co.uk/lettings-api/swagger/index.html
🔗
SwaggerUI
https://api.purplebricks.co.uk/branch-api/swagger/index.html
🔗
SwaggerUI
https://api.purplebricks.co.uk/communications-api/swagger/index.html
🔗
SwaggerUI
https://api.purplebricks.co.uk/conveyancing-api/swagger/index.html
🔗
SwaggerUI
https://api.purplebricks.co.uk/agent-api/swagger/index.html
🔗
SwaggerUI
https://api.purplebricks.co.uk/feedback-api/swagger/index.html
🔗
SwaggerUI
https://api.purplebricks.co.uk/workflow-api/swagger/index.html
🔗
SwaggerUI
https://api.purplebricks.co.uk/outlook-api/swagger/index.html

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/purplebricks-marketingpreferences-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

purplebricks-marketingpreferences-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Purplebricks Account API 1 - Platform Marketing Preferences API
  description: '### All Ex Uber Account related controllers are here.

    ### [Purplebricks Account API Git Repository](https://dev.azure.com/purplebricks/BackEnd/_git/account-api)'
  version: '1'
servers:
- url: https://api.purplebricks.co.uk/account-api
security:
- Bearer: []
tags:
- name: MarketingPreferences
paths:
  /v1/marketingpreferences/{publicUserId}:
    get:
      tags:
      - MarketingPreferences
      parameters:
      - name: publicUserId
        in: path
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: Success
          content:
            text/plain:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Purplebricks.Account.Business.Models.MarketingPreferencesResponseModel'
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Purplebricks.Account.Business.Models.MarketingPreferencesResponseModel'
            text/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Purplebricks.Account.Business.Models.MarketingPreferencesResponseModel'
        '401':
          description: Unauthorized
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails'
            application/json:
              schema:
                $ref: '#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails'
            text/json:
              schema:
                $ref: '#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails'
        '403':
          description: Forbidden
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails'
            application/json:
              schema:
                $ref: '#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails'
            text/json:
              schema:
                $ref: '#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails'
  /v1/marketingpreferences:
    put:
      tags:
      - MarketingPreferences
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Purplebricks.Account.Common.Models.MarketingPreferencesUpdateInputModel'
          text/json:
            schema:
              $ref: '#/components/schemas/Purplebricks.Account.Common.Models.MarketingPreferencesUpdateInputModel'
          application/*+json:
            schema:
              $ref: '#/components/schemas/Purplebricks.Account.Common.Models.MarketingPreferencesUpdateInputModel'
      responses:
        default:
          description: Error
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails'
            application/json:
              schema:
                $ref: '#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails'
            text/json:
              schema:
                $ref: '#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails'
        '401':
          description: Unauthorized
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails'
            application/json:
              schema:
                $ref: '#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails'
            text/json:
              schema:
                $ref: '#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails'
        '403':
          description: Forbidden
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails'
            application/json:
              schema:
                $ref: '#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails'
            text/json:
              schema:
                $ref: '#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails'
        '404':
          description: Not Found
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails'
            application/json:
              schema:
                $ref: '#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails'
            text/json:
              schema:
                $ref: '#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails'
        '204':
          description: Success
components:
  schemas:
    Purplebricks.Account.Business.Models.CustomerPreference:
      type: object
      properties:
        records:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/Purplebricks.Account.Business.Models.CustomerPreferenceRecord'
      additionalProperties: false
    Microsoft.AspNetCore.Mvc.ProblemDetails:
      type: object
      properties:
        type:
          type:
          - string
          - 'null'
        title:
          type:
          - string
          - 'null'
        status:
          type:
          - integer
          - 'null'
          format: int32
        detail:
          type:
          - string
          - 'null'
        instance:
          type:
          - string
          - 'null'
      additionalProperties: {}
    Purplebricks.Account.Business.Models.CustomerPreferenceRecord:
      type: object
      properties:
        customerPreferenceId:
          type:
          - string
          - 'null'
        channel:
          type:
          - string
          - 'null'
        status:
          type:
          - string
          - 'null'
        type:
          type:
          - string
          - 'null'
        code:
          type:
          - string
          - 'null'
        description:
          type:
          - string
          - 'null'
        label:
          type:
          - string
          - 'null'
        ordering:
          type:
          - integer
          - 'null'
          format: int32
      additionalProperties: false
    Purplebricks.Account.Common.Models.CustomerPreferenceRecordInputModel:
      type: object
      properties:
        customerPreferenceId:
          type:
          - string
          - 'null'
        channel:
          type:
          - string
          - 'null'
        status:
          type:
          - string
          - 'null'
        code:
          type:
          - string
          - 'null'
      additionalProperties: false
    Purplebricks.Account.Business.Models.MarketingPreferencesResponseModel:
      type: object
      properties:
        customerPreference:
          $ref: '#/components/schemas/Purplebricks.Account.Business.Models.CustomerPreference'
      additionalProperties: false
    Purplebricks.Account.Common.Models.MarketingPreferencesUpdateInputModel:
      type: object
      properties:
        publicUserId:
          type: string
          format: uuid
        updatedCustomerPreferenceRecords:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/Purplebricks.Account.Common.Models.CustomerPreferenceRecordInputModel'
      additionalProperties: false
  securitySchemes:
    Bearer:
      type: apiKey
      description: Authorization header using Bearer scheme
      name: Authorization
      in: header