Unsubscribe a business

DELETE 
https://api.staging.powerapi.com/api/v2/businesses/:business_id/subscriptions

This endpoint lets you unsubscribe a business to one or several products

Request

Path Parameters

business_id stringrequired

application/json

Bodyrequired

canceling_date number
Date of cancellation (UNIX timestamp)
Example: 1540628702
products string[]required
List of products being canceled
Possible values: [presence_management, review_management, review_booster, messages]
Example: ["presence_management"]

Responses

200

application/json

Schema

Schema

presence_management objectrequired
status stringrequired
Status of the management
Possible values: [active, inactive]
Example: inactive
review_management objectrequired
status stringrequired
Status of the management
Possible values: [active, inactive]
Example: inactive
review_booster objectrequired
status stringrequired
Status of the management
Possible values: [active, inactive]
Example: inactive
messages objectrequired
status stringrequired
Status of the management
Possible values: [active, inactive]
Example: inactive

Example (auto)

{
  "presence_management": {
    "status": "inactive"
  },
  "review_management": {
    "status": "inactive"
  },
  "review_booster": {
    "status": "inactive"
  },
  "messages": {
    "status": "inactive"
  }
}

400

application/json

Schema

Schema

statusCode integerrequired
HTTP status code
Example: 404
message string
Error message
Example: Cannot find item
error string
Error name
Example: Not Found

Example (auto)

{
  "statusCode": 404,
  "message": "Cannot find item",
  "error": "Not Found"
}

401

application/json

Schema

Schema

statusCode integerrequired
HTTP status code
Example: 404
message string
Error message
Example: Cannot find item
error string
Error name
Example: Not Found

Example (auto)

{
  "statusCode": 404,
  "message": "Cannot find item",
  "error": "Not Found"
}

403

application/json

Schema

Schema

statusCode integerrequired
HTTP status code
Example: 404
message string
Error message
Example: Cannot find item
error string
Error name
Example: Not Found

Example (auto)

{
  "statusCode": 404,
  "message": "Cannot find item",
  "error": "Not Found"
}

404

application/json

Schema

Schema

statusCode integerrequired
HTTP status code
Example: 404
message string
Error message
Example: Cannot find item
error string
Error name
Example: Not Found

Example (auto)

{
  "statusCode": 404,
  "message": "Cannot find item",
  "error": "Not Found"
}

422

application/json

Schema

Schema

statusCode integerrequired
HTTP status code
Example: 404
message string
Error message
Example: Cannot find item
location stringrequired
Where in the request the error occurred
Possible values: [query, body, response, param]
errors object[]required
Array [
path stringrequired
Path to the property with the error
Possible values: non-empty
Example: business.id
constraints objectrequired
property name* string
Error message
Example: Required property
]

Example (auto)

{
  "statusCode": 404,
  "message": "Cannot find item",
  "location": "query",
  "errors": [
    {
      "path": "business.id",
      "constraints": {
        "object_required_property": "Required property"
      }
    }
  ]
}

500

application/json

Schema

Schema

statusCode integerrequired
HTTP status code
Example: 404
message string
Error message
Example: Cannot find item
error string
Error name
Example: Not Found

Example (auto)

{
  "statusCode": 404,
  "message": "Cannot find item",
  "error": "Not Found"
}

Authorization: http

name: bearertype: httpscheme: bearerbearerFormat: JWT

• curl
• python
• go
• nodejs
• ruby
• java
• powershell

• CURL

curl -L -X DELETE 'https://api.staging.powerapi.com/api/v2/businesses/:business_id/subscriptions' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
-d '{
  "canceling_date": 1540628702,
  "products": [
    "presence_management"
  ]
}'

Request Collapse all

Base URL

https://api.staging.powerapi.com

Auth

Security Scheme

beareroauth2

Bearer Token

Parameters

business_id — pathrequired

Body required

{
  "canceling_date": 1540628702,
  "products": [
    "presence_management"
  ]
}

ResponseClear

Click the Send API Request button above and see the response here!