Submit user opt-out requests. Opted-out users will be removed from all audience segments you've ever created. You will receive a job_id that is unique to your opt-out request and you can use it to check the status anytime.

Note that we will process your opt-out requests within 15 days from when we have successfully received the request with valid data.

Endpoint: PUT /v1/optout

Request Body:

{  
  "email_sha256": [  
    "6d0484c44db3b2059358d33eb903578354a4b4a9ad4a3e091c653b0e00fa8fe9",  
    "ef874afd1f6331c5613e7d6c83f362c3d5e39acf8074caee8f49e9af6bbdaa6e"  
  ],  
  "ip": [  
    "65.92.195.168",  
    "72.77.210.96"  
  ],  
  "mobile_id": [  
    "ad23345f-b7f1-4351-a2d8-4d008d5cc96f",  
    "8fee62f4-d114-4c4a-b77c-eb7c886b14eb"
  ],
  "cookie": [
    "4eff9c2aa71f0d1a3c3b8dda58cfe1ee7f230b6fafdf3bbbd38c362bacc38824",
    "3f0540c1-55c2-4126-a19f-06daa2b078f2"
  ]
}

Response (Success):

{  
  "created": "2025-04-18T22:06:51.425229314Z",  
  "job_id": "22c81d36-21a0-4de5-8350-cacd5fc310f5",  
  "message": "Opt-out request created successfully",  
  "status": "REQUESTED"  
}

Failure Examples:

{  
  "error": "Invalid request: invalid SHA-256 hash format at index 3 in email_sha256"  
}

{  
  "error": "Invalid request: invalid IPv4 address at index 1 in ip"  
}