Purplebricks

Purplebricks Withdraw API

The Withdraw API from Purplebricks — 4 operation(s) for withdraw.

GitHub OpenAPI

Operations 4

POST /v1/withdraw
POST /v1/request
POST /v1/cancelrequest
POST /v1/creatio/withdraw

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-withdraw-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-withdraw-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-withdraw-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Purplebricks Property API 1.0 - Platform Withdraw API
  description: '### All Ex Uber Property related controllers are here.

    ### [Purplebricks Property API Git Repository](https://dev.azure.com/purplebricks/BackEnd/_git/property-api)'
  version: '1.0'
servers:
- url: https://api.purplebricks.co.uk/property-api
security:
- Bearer: []
tags:
- name: Withdraw
paths:
  /v1/withdraw:
    post:
      tags:
      - Withdraw
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Purplebricks.Property.Domain.Models.WithdrawPropertyRequestModel'
          text/json:
            schema:
              $ref: '#/components/schemas/Purplebricks.Property.Domain.Models.WithdrawPropertyRequestModel'
          application/*+json:
            schema:
              $ref: '#/components/schemas/Purplebricks.Property.Domain.Models.WithdrawPropertyRequestModel'
      responses:
        '200':
          description: Success
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/Purplebricks.Property.Domain.Models.WithdrawPropertyResponseModel'
            application/json:
              schema:
                $ref: '#/components/schemas/Purplebricks.Property.Domain.Models.WithdrawPropertyResponseModel'
            text/json:
              schema:
                $ref: '#/components/schemas/Purplebricks.Property.Domain.Models.WithdrawPropertyResponseModel'
        '400':
          description: Bad Request
          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'
        '500':
          description: Server Error
  /v1/request:
    post:
      tags:
      - Withdraw
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Purplebricks.Property.Domain.Models.RequestWithdrawProperty'
          text/json:
            schema:
              $ref: '#/components/schemas/Purplebricks.Property.Domain.Models.RequestWithdrawProperty'
          application/*+json:
            schema:
              $ref: '#/components/schemas/Purplebricks.Property.Domain.Models.RequestWithdrawProperty'
      responses:
        '200':
          description: Success
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/Purplebricks.Property.Domain.Models.WithdrawPropertyResponseModel'
            application/json:
              schema:
                $ref: '#/components/schemas/Purplebricks.Property.Domain.Models.WithdrawPropertyResponseModel'
            text/json:
              schema:
                $ref: '#/components/schemas/Purplebricks.Property.Domain.Models.WithdrawPropertyResponseModel'
        '400':
          description: Bad Request
          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'
        '500':
          description: Server Error
  /v1/cancelrequest:
    post:
      tags:
      - Withdraw
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Purplebricks.Property.Domain.Models.CancelRequestWithdrawProperty'
          text/json:
            schema:
              $ref: '#/components/schemas/Purplebricks.Property.Domain.Models.CancelRequestWithdrawProperty'
          application/*+json:
            schema:
              $ref: '#/components/schemas/Purplebricks.Property.Domain.Models.CancelRequestWithdrawProperty'
      responses:
        '200':
          description: Success
        '400':
          description: Bad Request
          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'
        '500':
          description: Server Error
  /v1/creatio/withdraw:
    post:
      tags:
      - Withdraw
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Purplebricks.Property.Domain.Models.WithdrawPropertyRequestModel'
          text/json:
            schema:
              $ref: '#/components/schemas/Purplebricks.Property.Domain.Models.WithdrawPropertyRequestModel'
          application/*+json:
            schema:
              $ref: '#/components/schemas/Purplebricks.Property.Domain.Models.WithdrawPropertyRequestModel'
      responses:
        '200':
          description: Success
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/Purplebricks.Property.Domain.Models.WithdrawPropertyResponseModel'
            application/json:
              schema:
                $ref: '#/components/schemas/Purplebricks.Property.Domain.Models.WithdrawPropertyResponseModel'
            text/json:
              schema:
                $ref: '#/components/schemas/Purplebricks.Property.Domain.Models.WithdrawPropertyResponseModel'
        '400':
          description: Bad Request
          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'
        '500':
          description: Server Error
components:
  schemas:
    Purplebricks.Property.Domain.Enums.WithdrawPropertyReason:
      enum:
      - NoLongerSelling
      - NoLongerLetting
      - MarketingBreak
      - SoldSTC_OtherAgent
      - SoldSTC_PrivateSale
      - LetSTC_OtherAgent
      - LetSTC_PrivateSale
      - SoldWithPurplebricks
      - LetWithPurplebricks
      type: string
    Purplebricks.Property.Domain.Models.CancelRequestWithdrawProperty:
      type: object
      properties:
        propertyId:
          type: integer
          format: int32
      additionalProperties: false
    Purplebricks.Property.Domain.Models.RequestWithdrawProperty:
      type: object
      properties:
        propertyId:
          type: integer
          format: int32
        withdrawPropertyReason:
          $ref: '#/components/schemas/Purplebricks.Property.Domain.Enums.WithdrawPropertyReason'
      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.Security.Auth.AuthUser:
      type: object
      properties:
        userId:
          type: integer
          format: int32
          readOnly: true
        publicUserId:
          type:
          - string
          - 'null'
          format: uuid
          readOnly: true
        impersonatorUserId:
          type: integer
          format: int32
          readOnly: true
        impersonatorPublicUserId:
          type:
          - string
          - 'null'
          format: uuid
          readOnly: true
      additionalProperties: false
    Purplebricks.Property.Domain.Models.WithdrawPropertyResponseModel:
      type: object
      properties:
        propertyId:
          type: integer
          format: int32
        propertyWithdrawn:
          type: boolean
        nonWithdrawalReason:
          type:
          - string
          - 'null'
      additionalProperties: false
    Purplebricks.Property.Domain.Models.WithdrawPropertyRequestModel:
      type: object
      properties:
        propertyId:
          type: integer
          format: int32
        withdrawalReason:
          $ref: '#/components/schemas/Purplebricks.Property.Domain.Enums.WithdrawPropertyReason'
        user:
          $ref: '#/components/schemas/Purplebricks.Security.Auth.AuthUser'
        collectBoard:
          type: boolean
        ipAddress:
          type:
          - string
          - 'null'
        forceAdvertWithdrawal:
          type: boolean
      additionalProperties: false
  securitySchemes:
    Bearer:
      type: apiKey
      description: Authorization header using Bearer scheme
      name: Authorization
      in: header