Update a Subject Access Request

1 min

POST

https://api.optimizely.com/v2/internal-subject-access-requests/{request_id}

Update a Subject Access Request by ID

Path Parameters

request_idinteger<int64>required
Description
The ID of the Subject Access Request to be updated.
Format
int64

Body Parameters

bodySubjectAccessRequestUpdaterequired
Description
A JSON string containing the Subject Access Request fields to be updated.
- completed_at_timestring<date-time>
  Description
  Time when the request was completed
  Format
  date-time
- export_locationstring
  Example
  s3://optimizely-sar-prod/{admin_account_id}-{parent_request_id}.zip
  Description
  s3 path to the Subject Access Request's ZIP file in the optimizely-sar-prod bucket
- processing_started_timestring<date-time>
  Description
  Time when the processing of the request started
  Format
  date-time
- statusstring<pending | processing | completed | failure>required
  Example
  processing
  Description
  Status of the Subject Access Request
  Allowed
  pendingprocessingcompletedfailure

Responses

200Return the updated Subject Access Request

SubjectAccessRequestInternal
- account_idinteger<int64>
  Description
  Admin account id
  Format
  int64
- completed_at_timestring<date-time>
  Description
  Time when the request was completed
  Format
  date-time
- data_sourcestring<app_backend | app_backend_infra | data_platform | datawarehouse | external_systems | optimizely | optimizely_on_optimizely | program_management | security | business_systems | marketing | tse>required
  Example
  optimizely
  Description
  Subject Access Request Data Source
  Allowed
  app_backendapp_backend_infradata_platformdatawarehouseexternal_systemsoptimizelyoptimizely_on_optimizelyprogram_managementsecuritybusiness_systemsmarketingtse
- data_typestring<user | visitor>required
  Example
  user
  Description
  Subject Access Request Data Type
  Allowed
  uservisitor
- expired_at_timestring<date-time>
  Description
  Time when the url expires (7 days from the completed_at_time)
  Format
  date-time
- export_locationstring
  Example
  s3://{bucket-name}/{account_id}/{parent_sar_id}/{sar_id}
  Description
  The location to which the data will be exported.
- idinteger<int64>
  Example
  12345
  Description
  Subject Access Request ID
  Format
  int64
- identifierstringrequired
  Example
  [email protected]
  Description
  Subject Access Request Identifier
- identifier_typestring<email | optimizely_end_user_id | dcp_id | fullstack_id | other>required
  Example
  email
  Description
  Subject Access Request Identifier Type
  Allowed
  emailoptimizely_end_user_iddcp_idfullstack_idother
- parent_request_idinteger<int64>
  Example
  12345
  Description
  Parent Subject Access Request id
  Format
  int64
- processing_started_timestring<date-time>
  Description
  Time when the processing of the request started
  Format
  date-time
- request_typestring<access | delete>required
  Example
  access
  Description
  Subject Access Request Request Type
  Allowed
  accessdelete
- requested_at_timestring<date-time>
  Description
  Time when the request was submitted
  Format
  date-time
- sla_deadline_timestring<date-time>
  Description
  Time by which the request must be deleted
  Format
  date-time
- statusstring<pending | processing | completed | failure>
  Example
  pending
  Description
  Status of the Subject Access Request
  Allowed
  pendingprocessingcompletedfailure

400Invalid ID or request body

Error
- codestring
- messagestring
- messagesobject
- uuidstring<uuid>
  Format
  uuid

401Invalid credentials

Error
- codestring
- messagestring
- messagesobject
- uuidstring<uuid>
  Format
  uuid

403You do not have permission to edit the specified Subject Access Request

Error
- codestring
- messagestring
- messagesobject
- uuidstring<uuid>
  Format
  uuid

404Subject Access Request not found

Error
- codestring
- messagestring
- messagesobject
- uuidstring<uuid>
  Format
  uuid

defaultUnexpected error

Error
- codestring
- messagestring
- messagesobject
- uuidstring<uuid>
  Format
  uuid

curl

curl --request POST \
     --url https://api.optimizely.com/v2/internal-subject-access-requests/{request_id} \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '{
     "status": "processing"
     }'

javascript

var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "application/json");

var raw = JSON.stringify({
   "status": "processing"
});

var requestOptions = {
   method: 'POST',
   headers: myHeaders,
   body: raw,
   redirect: 'follow'
};

fetch("https://api.optimizely.com/v2/internal-subject-access-requests/{request_id}", requestOptions)
   .then(response => response.text())
   .then(result => console.log(result))
   .catch(error => console.log('error', error));

ruby

require "uri"
require "json"
require "net/http"

url = URI("https://api.optimizely.com/v2/internal-subject-access-requests/{request_id}")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Post.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"
request.body = JSON.dump({
   "status": "processing"
})

response = https.request(request)
puts response.read_body

python

import requests
import json

url = "https://api.optimizely.com/v2/internal-subject-access-requests/{request_id}"

payload = json.dumps({
   "status": "processing"
})
headers = {
   'accept': 'application/json',
   'content-type': 'application/json'
}

response = requests.request("POST", url, headers=headers, data=payload)

print(response.text)

200

// Return the updated Subject Access Request
{
  "account_id": "",
  "completed_at_time": "",
  "data_source": "optimizely",
  "data_type": "user",
  "expired_at_time": "",
  "export_location": "s3://{bucket-name}/{account_id}/{parent_sar_id}/{sar_id}",
  "id": 12345,
  "identifier": "[email protected]",
  "identifier_type": "email",
  "parent_request_id": 12345,
  "processing_started_time": "",
  "request_type": "access",
  "requested_at_time": "",
  "sla_deadline_time": "",
  "status": "pending"
}

400

// Invalid ID or request body
{
  "code": "",
  "message": "",
  "messages": {},
  "uuid": ""
}

401

// Invalid credentials
{
  "code": "",
  "message": "",
  "messages": {},
  "uuid": ""
}

403

// You do not have permission to edit the specified Subject Access Request
{
  "code": "",
  "message": "",
  "messages": {},
  "uuid": ""
}

404

// Subject Access Request not found
{
  "code": "",
  "message": "",
  "messages": {},
  "uuid": ""
}

default

// Unexpected error
{
  "code": "",
  "message": "",
  "messages": {},
  "uuid": ""
}