{"info":{"_postman_id":"79be0264-f0c1-4339-88cc-4f87a27987d2","name":"Privacy API","description":"

The Privacy API allows you to submit requests to amend, export, or delete contact data in Simon.

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"11533956","collectionId":"79be0264-f0c1-4339-88cc-4f87a27987d2","publishedId":"T17Q6jiE","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2023-03-22T16:38:57.000Z"},"item":[{"name":"amend","item":[{"name":"List all requests to amend data for contacts.","id":"4008c335-9f2b-4c84-8048-792bb140f127","request":{"method":"GET","header":[],"url":"https://api.simondata.com/v1/privacy/amend","urlObject":{"path":["amend"],"host":["https://api.simondata.com/v1/privacy"],"query":[],"variable":[]}},"response":[{"id":"a0683a0b-74a4-485a-864a-bb03ed873407","name":"A list of all requests to amend data for contacts.","originalRequest":{"method":"GET","header":[],"url":"https://api.simondata.com/v1/privacy/amend"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": 1234567,\n \"action\": \"amend\",\n \"description\": \"Your description here\",\n \"email_address\": \"tom@hello.com\",\n \"user_id\": \"tom@hello.com\",\n \"user_id_type\": \"email_address\",\n \"state\": 2,\n \"emails_count\": 0,\n \"export_url\": null\n },\n {\n \"id\": 1234567,\n \"action\": \"amend\",\n \"description\": \"Your description here\",\n \"email_address\": \"tom@hello.com\",\n \"user_id\": \"tom@hello.com\",\n \"user_id_type\": \"email_address\",\n \"state\": 2,\n \"emails_count\": 0,\n \"export_url\": null\n }\n]"}],"_postman_id":"4008c335-9f2b-4c84-8048-792bb140f127"},{"name":"Submit a request to amend data for one or more contacts.","id":"1915af94-877b-4230-9fe9-57e1f7e2fd81","request":{"method":"POST","header":[],"url":"https://api.simondata.com/v1/privacy/amend","description":"

Submit a request to amend data for one or more contacts.

Requests can be submitted using the email address or a user ID for a contact.

If submitting an email address for a contact, the following arguments are required:
- email_address: a comma-separated list of email addresses\n representing the contact profiles to be amended.
- description - a plain text description of the fields or\n data to change, update, or remove.
\n
If submitting a user ID for a contact, the following arguments are required:
- user_id: a comma-separated list of user ids\n representing the contact profiles to be amended.
- user_id_type: The type of user_id; can be: riid,\n zendesk_id, subscription_key, email_hash,\n customerid, or customerguid.
- description - a plain text description of the fields or\n data to change, update, or remove.
\n

\n","urlObject":{"path":["amend"],"host":["https://api.simondata.com/v1/privacy"],"query":[],"variable":[]}},"response":[{"id":"db4cfb30-d390-44e6-834a-a961dbfd2556","name":"The amend request or list or list of amend requests created","originalRequest":{"method":"POST","header":[],"url":"https://api.simondata.com/v1/privacy/amend"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": 1234567,\n \"action\": \"delete\",\n \"description\": \"Your description here\",\n \"email_address\": \"tom@hello.com\",\n \"user_id\": \"tom@hello.com\",\n \"user_id_type\": \"email_address\",\n \"state\": 2,\n \"emails_count\": 0,\n \"export_url\": null\n }\n]"}],"_postman_id":"1915af94-877b-4230-9fe9-57e1f7e2fd81"},{"name":"List all requests to amend data for contacts.","id":"fcb86c63-d945-4778-8905-b9c8d11c48e5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.simondata.com/v1/privacy/amend/:id","urlObject":{"path":["amend",":id"],"host":["https://api.simondata.com/v1/privacy"],"query":[],"variable":[{"description":{"content":"

ID of the amend request

\n","type":"text/plain"},"type":"string","value":"1234567","key":"id"}]}},"response":[{"id":"6c4e1e1f-999b-4e21-bc54-91f3f7a2da58","name":"The amend request matching the ID requested.","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.simondata.com/v1/privacy/amend/:id","host":["https://api.simondata.com/v1/privacy"],"path":["amend",":id"],"variable":[{"key":"id","value":"1234567","description":"ID of the amend request"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 1234567,\n \"action\": \"amend\",\n \"description\": \"Your description here\",\n \"email_address\": \"tom@hello.com\",\n \"user_id\": \"tom@hello.com\",\n \"user_id_type\": \"email_address\",\n \"state\": 2,\n \"emails_count\": 0,\n \"export_url\": null\n}"}],"_postman_id":"fcb86c63-d945-4778-8905-b9c8d11c48e5"}],"id":"014bc173-e89d-4ab4-a657-58dddff30c82","_postman_id":"014bc173-e89d-4ab4-a657-58dddff30c82","description":""},{"name":"delete","item":[{"name":"List all requests to delete data for contacts.","id":"cda6eabb-0844-4128-a8ab-70ecf8736736","request":{"method":"GET","header":[],"url":"https://api.simondata.com/v1/privacy/delete/","urlObject":{"path":["delete",""],"host":["https://api.simondata.com/v1/privacy"],"query":[],"variable":[]}},"response":[{"id":"a882fc0d-bc32-4931-a28e-0c86183cc47e","name":"A list of all requests to delete data for contacts.","originalRequest":{"method":"GET","header":[],"url":"https://api.simondata.com/v1/privacy/delete/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": 1234567,\n \"action\": \"delete\",\n \"description\": \"Your description here\",\n \"email_address\": \"tom@hello.com\",\n \"user_id\": \"tom@hello.com\",\n \"user_id_type\": \"email_address\",\n \"state\": 2,\n \"emails_count\": 0,\n \"export_url\": null\n },\n {\n \"id\": 1234567,\n \"action\": \"delete\",\n \"description\": \"Your description here\",\n \"email_address\": \"tom@hello.com\",\n \"user_id\": \"tom@hello.com\",\n \"user_id_type\": \"email_address\",\n \"state\": 2,\n \"emails_count\": 0,\n \"export_url\": null\n }\n]"}],"_postman_id":"cda6eabb-0844-4128-a8ab-70ecf8736736"},{"name":"Submit a request to delete data for one or more contacts.","id":"11cf8a48-8d81-4b7e-b5ac-6bf143cdf388","request":{"method":"POST","header":[],"url":"https://api.simondata.com/v1/privacy/delete/","description":"

Requests can be submitted using the email address or a user ID for a contact.

If submitting an email address for a contact, the following arguments are required:
- email_address: a comma-separated list of email addresses
  representing the contact profiles to be deleted.
- description - a plain text description of the fields or
  data to change, update, or remove.
\n
If submitting a user ID for a contact, the following arguments are required:
- user_id: a comma-separated list of user ids
  representing the contact profiles to be deleted.
- user_id_type: The type of user_id; can be: riid,
  zendesk_id, subscription_key, email_hash,
  customerid, or customerguid.
- description - a plain text description of the fields or
  data to change, update, or remove.
\n

\n","urlObject":{"path":["delete",""],"host":["https://api.simondata.com/v1/privacy"],"query":[],"variable":[]}},"response":[{"id":"14b6c318-0299-4fce-a63b-75c0b92c039e","name":"The delete request or list or list of delete requests created","originalRequest":{"method":"POST","header":[],"url":"https://api.simondata.com/v1/privacy/delete/"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": 1234567,\n \"action\": \"delete\",\n \"description\": \"Your description here\",\n \"email_address\": \"tom@hello.com\",\n \"user_id\": \"tom@hello.com\",\n \"user_id_type\": \"email_address\",\n \"state\": 2,\n \"emails_count\": 0,\n \"export_url\": null\n },\n {\n \"id\": 1234567,\n \"action\": \"delete\",\n \"description\": \"Your description here\",\n \"email_address\": \"tom@hello.com\",\n \"user_id\": \"tom@hello.com\",\n \"user_id_type\": \"email_address\",\n \"state\": 2,\n \"emails_count\": 0,\n \"export_url\": null\n }\n]"}],"_postman_id":"11cf8a48-8d81-4b7e-b5ac-6bf143cdf388"},{"name":"Retrieve the status of a request to delete data for one or more contacts.","id":"e863491a-59f6-4405-8dde-33ac3ea7790e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.simondata.com/v1/privacy/delete/:id","urlObject":{"path":["delete",":id"],"host":["https://api.simondata.com/v1/privacy"],"query":[],"variable":[{"description":{"content":"

ID of the delete request

\n","type":"text/plain"},"type":"string","value":"1234567","key":"id"}]}},"response":[{"id":"04069dea-61c9-441c-9c67-24ddb4fabe39","name":"The deletion request matching the ID requested.","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.simondata.com/v1/privacy/delete/:id","host":["https://api.simondata.com/v1/privacy"],"path":["delete",":id"],"variable":[{"key":"id","value":"1234567","description":"ID of the delete request"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 1234567,\n \"action\": \"delete\",\n \"description\": \"Your description here\",\n \"email_address\": \"tom@hello.com\",\n \"user_id\": \"tom@hello.com\",\n \"user_id_type\": \"email_address\",\n \"state\": 2,\n \"emails_count\": 0,\n \"export_url\": null\n}"}],"_postman_id":"e863491a-59f6-4405-8dde-33ac3ea7790e"}],"id":"33712df2-4c58-43fd-9e48-ad75a8bd3a8f","_postman_id":"33712df2-4c58-43fd-9e48-ad75a8bd3a8f","description":""},{"name":"export","item":[{"name":"List all requests to export data for contacts.","id":"2f4ba0bc-7092-4da9-aa2b-37d1facd5b85","request":{"method":"GET","header":[],"url":"https://api.simondata.com/v1/privacy/export","urlObject":{"path":["export"],"host":["https://api.simondata.com/v1/privacy"],"query":[],"variable":[]}},"response":[{"id":"3f271841-e9ad-4a3a-a080-e0bef9906add","name":"A list of all requests to export data for contacts.","originalRequest":{"method":"GET","header":[],"url":"https://api.simondata.com/v1/privacy/export"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": 1234567,\n \"action\": \"export\",\n \"description\": \"Your description here\",\n \"email_address\": \"tom@hello.com\",\n \"user_id\": \"tom@hello.com\",\n \"user_id_type\": \"email_address\",\n \"state\": 2,\n \"emails_count\": 0,\n \"export_url\": null\n },\n {\n \"id\": 1234567,\n \"action\": \"export\",\n \"description\": \"Your description here\",\n \"email_address\": \"tom@hello.com\",\n \"user_id\": \"tom@hello.com\",\n \"user_id_type\": \"email_address\",\n \"state\": 2,\n \"emails_count\": 0,\n \"export_url\": null\n }\n]"}],"_postman_id":"2f4ba0bc-7092-4da9-aa2b-37d1facd5b85"},{"name":"Submit a request to export data for one or more contacts.","id":"fef04391-d174-4694-81f2-1e663377ea74","request":{"method":"POST","header":[],"url":"https://api.simondata.com/v1/privacy/export","description":"

Requests can be submitted using the email address or a user ID for a contact.

If submitting an email address for a contact, the following arguments are required:
- email_address: a comma-separated list of email addresses
  representing the contact profiles to be exported.
- description - a plain text description of the fields or
  data to change, update, or remove.
\n
If submitting a user ID for a contact, the following arguments are required:
- user_id: a comma-separated list of user ids
  representing the contact profiles to be exported.
- user_id_type: The type of user_id; can be: riid,
  zendesk_id, subscription_key, email_hash,
  customerid, or customerguid.
- description - a plain text description of the fields or
  data to change, update, or remove.
\n

\n","urlObject":{"path":["export"],"host":["https://api.simondata.com/v1/privacy"],"query":[],"variable":[]}},"response":[{"id":"d202caa7-c7bd-43eb-9870-da04bba93eff","name":"The export request or list or list of export requests created","originalRequest":{"method":"POST","header":[],"url":"https://api.simondata.com/v1/privacy/export"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": 1234567,\n \"action\": \"export\",\n \"description\": \"Your description here\",\n \"email_address\": \"tom@hello.com\",\n \"user_id\": \"tom@hello.com\",\n \"user_id_type\": \"email_address\",\n \"state\": 2,\n \"emails_count\": 0,\n \"export_url\": null\n },\n {\n \"id\": 1234567,\n \"action\": \"export\",\n \"description\": \"Your description here\",\n \"email_address\": \"tom@hello.com\",\n \"user_id\": \"tom@hello.com\",\n \"user_id_type\": \"email_address\",\n \"state\": 2,\n \"emails_count\": 0,\n \"export_url\": null\n }\n]"}],"_postman_id":"fef04391-d174-4694-81f2-1e663377ea74"},{"name":"Retrieve the status of a request to export data for one or more contacts.","id":"170b7c1d-7960-481b-b96d-2c2892e66b9b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.simondata.com/v1/privacy/export/:id","urlObject":{"path":["export",":id"],"host":["https://api.simondata.com/v1/privacy"],"query":[],"variable":[{"description":{"content":"

ID of the export request

\n","type":"text/plain"},"type":"string","value":"1234567","key":"id"}]}},"response":[{"id":"f9e0256f-ef08-4c54-b980-9dc35847894b","name":"The export request matching the ID requested.","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.simondata.com/v1/privacy/export/:id","host":["https://api.simondata.com/v1/privacy"],"path":["export",":id"],"variable":[{"key":"id","value":"1234567","description":"ID of the export request"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 1234567,\n \"action\": \"export\",\n \"description\": \"Your description here\",\n \"email_address\": \"tom@hello.com\",\n \"user_id\": \"tom@hello.com\",\n \"user_id_type\": \"email_address\",\n \"state\": 2,\n \"emails_count\": 0,\n \"export_url\": null\n}"}],"_postman_id":"170b7c1d-7960-481b-b96d-2c2892e66b9b"}],"id":"ff63a7fe-9797-44d8-bf8b-eade3ee1ebf8","_postman_id":"ff63a7fe-9797-44d8-bf8b-eade3ee1ebf8","description":""}],"event":[{"listen":"prerequest","script":{"id":"16ae496f-72fb-4b8d-aabb-9d9e5f7aac62","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"a4e85c02-6340-4626-adce-8fdd4f811d3f","type":"text/javascript","exec":[""]}}],"variable":[{"key":"baseUrl","value":"https://api.simondata.com/v1/privacy"}]}