Update an opt out request

PUT 
/api/v2/opt_outs/:uuid

Update an opt out request

Request

Path Parameters

uuid stringrequired
The unique identifier of the opt out request you want to update
Example: 7efa58a8-9b7d-4faf-8082-5f7f7f407db7

Header Parameters

authorization stringrequired
Example: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9

application/json

Body

first_name string
The first name of the person wanting to opt out of the sharing or selling of their data
Example: Chuck
last_name string
The last name of the person wanting to opt out of the sharing or selling of their data
Example: Norris
email string
The email address of the person wanting to opt out of sharing or selling of their data
Example: chuck.norris@example.com
location string
The location of the person wanting to opt out
Example: US-CA
additional_info string
Any additional details the user might want to add to their request
Example: Additional information

Responses

200

Opt Out Request updated

application/json

Schema

Schema

created_at string
Datetime of when the opt out was created.
Example: 2024-08-09T21:14:49.444Z
email string
The email associated with the data subject.
Example: john@example.com
first_name string
The first name of the data subject.
Example: John
last_name string
The last name of the data subject.
Example: Smith
location string
The location the data subject when they submitted the request.
Example: US
status string
The status of the request.
Example: not_started
uuid string
The unique identifier of the request.
Example: 967e34da-4863-4fcf-842d-176dd102d032

Example (from schema)

{
  "created_at": "2024-08-09T21:14:49.444Z",
  "email": "john@example.com",
  "first_name": "John",
  "last_name": "Smith",
  "location": "US",
  "status": "not_started",
  "uuid": "967e34da-4863-4fcf-842d-176dd102d032"
}

404

Not able to find a request with the ID provided

422

Invalid Request