Skip to main content

Create an opt out request

POST 
/api/v2/opt_outs

Create an opt out request

Request​

Query Parameters

    set_cookie boolean

    Whether or not the Do Not Sell cookie should be set on form submit

    Example: true

Header Parameters

    authorization stringrequired
    Example: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9

Body

    first_name stringrequired

    The first name of the person wanting to opt out of the sharing or selling of their data

    last_name stringrequired

    The last name of the person wanting to opt out of the sharing or selling of their data

    email_address stringrequired

    The email address of the person wanting to opt out of sharing or selling of their data

    location string

    The location of the person wanting to opt out

    privacy_request_policy_id string

    The privacy request policy UUID that is associated with the opt out request

    additional_info string

    Any additional details the user might want to add to their request

    authorized_agent boolean

    Whether or not the request has been submitted by an authorized agent or not

    authorized_agent_first_name string

    The first name of the authorized agent that is submitting the request. Is required if authorized_agent is true.

    authorized_agent_last_name string

    The last name of the authorized agent that is submitting the request. Is required if authorized_agent is true.

    authorized_agent_last_email string

    The email of the authorized agent that is submitting the request. Is required if authorized_agent is true.

Responses​

Opt Out Request created

Schema

    created_at string

    Datetime of when the opt out was created.

    email string

    The email associated with the data subject.

    first_name string

    The first name of the data subject.

    last_name string

    The last name of the data subject.

    location string

    The location the data subject when they submitted the request.

    status string

    The status of the request.

    uuid string

    The unique identifier of the request.

Loading...

 

Need help?
If you have any questions, please reach out to your dedicated CSM or contact us at support@datagrail.io.

Disclaimer: The information contained in this message does not constitute as legal advice. We would advise seeking professional counsel before acting on or interpreting any material.