{ "opencollection": "1.0.0", "info": { "name": "API Reference Accounting Codes Contacts API", "version": "2023-12-15" }, "items": [ { "info": { "name": "Contacts", "type": "folder" }, "items": [ { "info": { "name": "Scrub a contact", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/contacts/:contactId/scrub", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" }, { "name": "Zuora-Track-Id", "value": "" } ], "params": [ { "name": "contactId", "value": "", "type": "path", "description": "The ID of the contact that you want to scrub sensitive data from.\n" } ] }, "docs": "\nScrubs the sensitive data of a specific contact. \n\nYou can use this operation to replace all sensitive data in a contact and its related contact snapshot with dummy values that will be stored in Zuora databases. \n\nAfter scrubbing a contact, it is good practice to delete it. Otherwise, it might cause errors in subsequent operations.\n\n**Note**: To use this operation, you must ensure that the \"Scrub Sensitive Data of Contact\" billing permission is enabled in your user role. Contact your tenant adm" }, { "info": { "name": "Create a contact", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/contacts", "headers": [ { "name": "Idempotency-Key", "value": "" }, { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" }, { "name": "Zuora-Track-Id", "value": "" } ] }, "docs": "Creates a contact for a specified account.\n" }, { "info": { "name": "Retrieve a contact", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/contacts/:contactId", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" }, { "name": "Zuora-Track-Id", "value": "" } ], "params": [ { "name": "contactId", "value": "", "type": "path", "description": "The ID of the contact that you want to retrieve.\n" } ] }, "docs": "Retrieves detailed information about a specific contact.\n" }, { "info": { "name": "Update a contact", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/contacts/:contactId", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" }, { "name": "Zuora-Track-Id", "value": "" } ], "params": [ { "name": "contactId", "value": "", "type": "path", "description": "The ID of the contact that you want to update.\n" } ] }, "docs": "Updates a contact for a specified account.\n\nYou can update contacts for cancelled accounts.\n" }, { "info": { "name": "Delete a contact", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v1/contacts/:contactId", "headers": [ { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" }, { "name": "Zuora-Track-Id", "value": "" } ], "params": [ { "name": "contactId", "value": "", "type": "path", "description": "The ID of the contact that you want to delete.\n" } ] }, "docs": "Deletes a contact.\n" } ] } ], "bundled": true }