Sign in

v4

latestOpenAPI 3.0.02026-08-04109113304.5 KB
Subject Access Requests

Update a Subject Access Request

Update a Subject Access Request by ID

post/internal-subject-access-requests/{request_id}

Path parameters

request_idinteger required

The ID of the Subject Access Request to be updated.

Request body

completed_at_timestring date-time nullable

Time when the request was completed

export_locationstring

s3 path to the Subject Access Request's ZIP file in the optimizely-sar-prod bucket

processing_started_timestring date-time nullable

Time when the processing of the request started

status'pending' | 'processing' | 'completed' | 'failure' required

Status of the Subject Access Request

Example request

{
  "export_location": "s3://optimizely-sar-prod/{admin_account_id}-{parent_request_id}.zip",
  "status": "processing"
}

Response

Return the updated Subject Access Request

account_idinteger

Admin account id

completed_at_timestring date-time nullable

Time when the request was completed

data_source'app_backend' | 'app_backend_infra' | 'data_platform' | 'datawarehouse' | 'external_systems' | 'optimizely' | 'optimizely_on_optimizely' | 'program_management' | 'security' | 'business_systems' | 'marketing' | 'tse' required

Subject Access Request Data Source

data_type'user' | 'visitor' required

Subject Access Request Data Type

expired_at_timestring date-time

Time when the url expires (7 days from the completed_at_time)

export_locationstring

The location to which the data will be exported.

idinteger

Subject Access Request ID

identifierstring required

Subject Access Request Identifier

identifier_type'email' | 'optimizely_end_user_id' | 'dcp_id' | 'fullstack_id' | 'other' required

Subject Access Request Identifier Type

parent_request_idinteger

Parent Subject Access Request id

processing_started_timestring date-time nullable

Time when the processing of the request started

request_type'access' | 'delete' required

Subject Access Request Request Type

requested_at_timestring date-time

Time when the request was submitted

sla_deadline_timestring date-time

Time by which the request must be deleted

status'pending' | 'processing' | 'completed' | 'failure'

Status of the Subject Access Request

Example response

{
  "data_source": "optimizely",
  "data_type": "user",
  "export_location": "s3://{bucket-name}/{account_id}/{parent_sar_id}/{sar_id}",
  "id": 12345,
  "identifier": "test@optimizely.com",
  "identifier_type": "email",
  "parent_request_id": 12345,
  "request_type": "access",
  "status": "pending"
}