v1

latestOpenAPI 3.0.02026-07-14198572488.4 KB

ShopShield

Enable ShopShield for a URI

post/v1/sites/{id}/shop_shield

Path parameters

idinteger required

ID of the Site you are interacting with

Example:8880000888

Request body

uristring required

The URI that is protected by ShopShield. Must start with a / or the domain such as https://example.com/shop or /shop

notify_site_ownerboolean

Whether to notify the site owner when ShopShield is enabled

Example request

{
  "uri": "/"
}

Response

successboolean

whether the request succeeded

errorsstring[]

messagesstring[] nullable

Example response

{
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "uri": "/",
    "created_at": "2021-01-01T00:00:00Z",
    "updated_at": "2021-01-01T00:00:00Z"
  }
}