{ "opencollection": "1.0.0", "info": { "name": "Helpcenter Contacts API", "version": "1.0.0" }, "items": [ { "info": { "name": "Contacts", "type": "folder" }, "items": [ { "info": { "name": "Link Emails to Deals", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/Contacts/:contactId/Emails/actions/link_record", "params": [ { "name": "contactId", "value": "", "type": "path", "description": "The ID of the contact to which the email is to be linked or unlinked" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Links the emails to the specified deals in CRM." }, { "info": { "name": "Unlink Emails from Records", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/Contacts/:contactId/Emails/actions/link_record", "params": [ { "name": "contactId", "value": "", "type": "path", "description": "The ID of the contact to which the email is to be linked or unlinked" }, { "name": "message_ids", "value": "", "type": "query", "description": "The IDs of the email messages to be linked" }, { "name": "owner_id", "value": "", "type": "query", "description": "The ID of the owner of the contact" } ] }, "docs": "Unlinks the emails from the specified records in CRM." }, { "info": { "name": "Link Email to Record", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/Contacts/:contactId/Emails/:messageId/actions/link_record", "params": [ { "name": "contactId", "value": "", "type": "path", "description": "The ID of the contact to which the email is to be linked or unlinked" }, { "name": "messageId", "value": "", "type": "path", "description": "The ID of the email message to be linked or unlinked" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Links an email to a specified record in CRM." }, { "info": { "name": "Unlink Email from Record", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/Contacts/:contactId/Emails/:messageId/actions/link_record", "params": [ { "name": "contactId", "value": "", "type": "path", "description": "The ID of the contact to which the email is to be linked or unlinked" }, { "name": "messageId", "value": "", "type": "path", "description": "The ID of the email message to be linked or unlinked" }, { "name": "owner_id", "value": "", "type": "query", "description": "The ID of the owner of the contact" } ] }, "docs": "Unlinks an email from a specified record in CRM." }, { "info": { "name": "Get Contact Roles", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/contacts/roles" }, "docs": "Retrieves a list of contact roles" }, { "info": { "name": "Create Contact Roles", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/contacts/roles", "body": { "type": "json", "data": "{}" } }, "docs": "Creates one or more contact roles." }, { "info": { "name": "Update Contact Roles", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/contacts/roles", "body": { "type": "json", "data": "{}" } }, "docs": "Updates one or more contact roles." }, { "info": { "name": "Delete Contact Roles", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/contacts/roles", "params": [ { "name": "ids", "value": "", "type": "query", "description": "Comma-separated list of contact role IDs to operate on." } ] }, "docs": "Deletes one or more contact roles by their IDs." }, { "info": { "name": "Get Role", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/contacts/roles/:role", "params": [ { "name": "role", "value": "", "type": "path", "description": "The unique identifier of the contact role." } ] }, "docs": "Retrieves a specific contact role by its ID" }, { "info": { "name": "Update Role", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/contacts/roles/:role", "params": [ { "name": "role", "value": "", "type": "path", "description": "The unique identifier of the contact role." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a specific contact role by its ID." }, { "info": { "name": "Delete Role", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/contacts/roles/:role", "params": [ { "name": "role", "value": "", "type": "path", "description": "The unique identifier of the contact role." } ] }, "docs": "Deletes a specific contact role by ID." } ] } ], "bundled": true }