Create Personal Data Erasure Request

POST 
https://useast.api.elasticpath.com/v2/personal-data/erasure-requests

This request serves to create a new erasure request for a given resource ID and Type. All resources that belong to the same personal data set will be erased.

Request

application/json

Body

data ErasureRequestrequired

resource_type string

The type of the data entry to be erased.

resource_id uuid

The ID of the data entry to be erased (note that also all data entries in the personal data set will be erased).

type stringrequired

The type of the object. Always equal to erasure_request.

Responses

201

Created

application/json

Schema

Schema

data object

id uuid

The unique identifier for the log entry.

resource_type string

The type of the data entry to be erased.

resource_id uuid

The ID of the data entry to be erased (note that also all data entries in the personal data set will be erased).

type string

The type of the object. Always equal to erasure_request.

initiator object

Specifies who initiated the erasure request.

access-token-email string

access-token-id string

access-token-name string

access-token-store-id uuid

access-token-type string

status string

Specifies the status of the erasure request.

status_description string

Elaborates on the erasure request status.

created_at string

Specifies the status of the erasure request.

updated_at string

Elaborates on the erasure request status.

links object

self string

The self link.

Example (from schema)

{
  "data": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "resource_type": "account",
    "resource_id": "98140362-6caf-4829-b93d-953ac6adbe6e",
    "type": "string",
    "initiator": {
      "access-token-email": "accounts@elasticpath.com",
      "access-token-id": 1222341536243516000,
      "access-token-name": "elastic path test team",
      "access-token-store-id": "15ea9633-278c-4807-80f7-2009fed63c7e",
      "access-token-type": "client-credentials-token"
    },
    "status": "string",
    "status_description": "string",
    "created_at": "string",
    "updated_at": "string",
    "links": {
      "self": "string"
    }
  }
}

postErasureRequest

{
  "data": {
    "id": "fb25ecd9-c610-4659-97d6-0a7550ac0ddc",
    "type": "erasure_request",
    "resource_id": "98140362-6caf-4829-b93d-953ac6adbe6e",
    "resource_type": "account",
    "initiator": {
      "access-token-email": "accounts@molt.in",
      "access-token-id": "1222341536243515939",
      "access-token-name": "moltin test team",
      "access-token-store-id": "15ea9633-278c-4807-80f7-2009fed63c7e",
      "access-token-type": "client-credentials-token"
    },
    "status": "CREATED",
    "status_description": "The erasure request successfully created",
    "created_at": "2022-06-07T12:25:38.52Z",
    "updated_at": "2022-06-07T12:25:38.69Z",
    "links": {
      "self": "https://useast.api.elasticpath.com/v2/personal-data/erasure-requests/fb25ecd9-c610-4659-97d6-0a7550ac0ddc"
    }
  }
}

400

Bad Request

application/json

Schema

Schema

errors Error[]required
Array [
title stringrequired
A brief summary of the error.
status stringrequired
The HTTP response code of the error.
detail string
Optional additional detail about the error.
]

Example (from schema)

{
  "errors": [
    {
      "title": "string",
      "status": "string",
      "detail": "string"
    }
  ]
}

bad-request-error

Required field missing

{
  "errors": [
    {
      "title": "Bad Request",
      "status": "400",
      "detail": "Validation failed: field 'Type' on the 'ttl-type' tag."
    }
  ]
}

default

Internal server error.

application/json

Schema

Schema

errors Error[]required
Array [
title stringrequired
A brief summary of the error.
status stringrequired
The HTTP response code of the error.
detail string
Optional additional detail about the error.
]

Example (from schema)

{
  "errors": [
    {
      "title": "string",
      "status": "string",
      "detail": "string"
    }
  ]
}

internal-server-error

Internal server error

{
  "errors": [
    {
      "title": "Internal Server Error",
      "status": "500",
      "detail": "there was a problem processing your request"
    }
  ]
}

Authorization: http

name: bearerAuthtype: httpscheme: bearer

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

• CURL

curl -L -X POST 'https://useast.api.elasticpath.com/v2/personal-data/erasure-requests' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "data": {
    "resource_type": "account",
    "resource_id": "98140362-6caf-4829-b93d-953ac6adbe6e",
    "type": "string"
  }
}'

Request Collapse all

Base URL

https://useast.api.elasticpath.com

Auth

Bearer Token

Body

{
  "data": {
    "resource_type": "account",
    "resource_id": "98140362-6caf-4829-b93d-953ac6adbe6e",
    "type": "string"
  }
}

ResponseClear

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