POST /subject-access-requests

Create a Subject Access Request

Servers

https://api.optimizely.com/v2

Request headers

Name	Type	Required	Description
`Content-Type`	String	Yes	The media type of the request body. Default value: "application/json"

Request body fields

Name	Type	Required	Description
`export_location`	String	No	The location to which the data will be exported. The data will be made accessible in a AWS S3 bucket.
`expired_at_time`	String	No	Time when the url expires (7 days from the completed_at_time)
`sla_deadline_time`	String	No	The time by which the Subject Access Request must be completed.
`status`	String	No	The status of the Subject Access Request. Valid values: `"completed"` `"pending"` `"failure"` `"processing"`
`id`	Integer	No	The Subject Access Request ID.
`request_type`	String	Yes	`delete` - Removes all data within an account that is associated to the identifier defined in the identifier field. `access` - Finds all data stored in Optimizely systems associated to the identifier defined in the identifier field and exports it to an AWS S3 bucket for you to access. Valid values: `"delete"` `"access"`
`requested_at_time`	String	No	The time when the Subject Access Request was submitted.
`identifier_type`	String	Yes	User data is identified by the email address used to create the end user account. The endpoint only accepts the `email` datatype if you selected `user` for Datatype. If you selected `visitor` for data_type, you can select 5 options for personal identifier types: `dcp_id` - Any ID used to identify targeting records in Optimizely. `email` - The email address of a visitor. `fullstack_id` - The unique identifier used for Full Stack experiments. `optimizely_end_user_id` - An Optimizely generated user cookie. `other` - Any other identifier that was uploaded to Optimizely. Valid values: `"email"` `"other"` `"dcp_id"` `"optimizely_end_user_id"` `"fullstack_id"`
`processing_started_time`	String	No	The time when the processing of the Subject Access Request started.
`data_type`	String	Yes	The type of data to be accessed or deleted. The two options are: `user` - End users (also known as Collaborators) that are added to the accounts of our customers. A user can be a collaborator on multiple accounts. `visitor` - Visitors who visit or use our customers’ websites, apps and other digital products. Optimizely stores visitor data to calculate experiment results and to tailor content. Valid values: `"visitor"` `"user"`
`identifier`	String	Yes	The identifier value that you would like us to use when searching. If `user` was selected in the previous step, the identifier will be the email address for the User.
`account_id`	Integer	No	The Account ID for the account the Subject Access Request will be executed.
`completed_at_time`	String	No	The time when the request was completed.

How to start integrating

Add HTTP Task to your workflow definition.
Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
Click Test request to test run your request to the API and see the API's response.