CasaYes
  • Home
  • Integration
    • Integration Documentation
    • API
      • Listing
        • Create
        • Update
        • Delete
      • Token
        • Create
    • FTP
      • Integration via FTP
    • Schemas
      • Listing Schema
  • Webhooks
    • Webhooks
    • Listing
    • Leads
Powered by GitBook
On this page
  • Method DELETE
  • Headers
  • Example Request
  • Example Response
  1. Integration
  2. API
  3. Listing

Delete

api/v1/Listing/{listingReferenceId}

Description: Request for a listing to be deleted.

Method DELETE

Headers

Name
Type
Description

Authorization

string

Bearer token used to authenticate your API request. Include the token in the format Bearer YOUR_API_KEY.

office-integration-secret

string

Integration secret for a given office.

listingReferenceId

string

Reference Id of the listing to be deleted.

Example Request

Method: DELETE
Headers: 
    { 
        "Authorization": "Bearer eyJhbGciOiJSUzI1NiIsImtpZCI6IjZGODU0MEQyMzVGOTRBNjU3OUZENjM4RDQ5REE0NzVBODY5QzYzQ0EiLCJ4NXQiOiJiNFZBMGpYNVNtVjVfV09OU2RwSFdvYWNZOG8iLCJ0eXAiOiJhdCtqd3QifQ.eyJpc3MiOiJodHRwczovL2xvZ2luLWRldi5jYXNheWVzLnB0LyIsImV4cCI6MTcyMjk0MTI2MywiaWF0IjoxNzIyOTM3NjYzLCJhdWQiOiJSZWFsRXN0YXRlLk1MUy5CYWNrb2ZmaWNlLlB1YmxpYyIsInNjb3BlIjoiUmVhbEVzdGF0ZS5NTFMuQmFja29mZmljZS5QdWJsaWMuTWFuYWdlIiwianRpIjoiMjU4OTZhYzQtNGI2OC00Njc4LWJkZGEtYjU1MjQ2Y2RhNTE1Iiwic3ViIjoiQ2FzYVllcy5SZW1heC5JbnRlZ3JhdGlvbiIsIm5hbWUiOiJDYXNhWWVzIFJlbWF4IEludGVncmF0aW9uIiwib2lfcHJzdCI6IkNhc2FZZXMuUmVtYXguSW50ZWdyYXRpb24iLCJjbGllbnRfaWQiOiJDYXNhWWVzLlJlbWF4LkludGVncmF0aW9uIiwib2lfdGtuX2lkIjoiODAzMzg2NjQtOWE1ZS00MmNhLTliYzYtMzMzMWNhMTVmN2Y4In00",
        "office-integration-secret": "003_16623336828_5FB1148E-8E71-4CA1-2N89-B3F195882817",
        "listingReferenceId": "20240806-0957"
    }

Example Response

Code: 200
Body: 
    { 
        "success": true,
        "correlationId": "string",
        "publicId": "string",
        "status": "Processing"
    }
Code: 400
Body: 
    {
        "success": true,
        "correlationId": "string",
        "publicId": "string",
        "status": "Invalid",
        "errorCode": "string",
        "modelErrors": ["string"]
    }
Code: 401
Invalid access token or office integration token!
PreviousUpdateNextToken

Last updated 7 months ago