{
  "opencollection": "1.0.0",
  "info": {
    "name": "Helpcenter Contact Roles API",
    "version": "1.0.0"
  },
  "items": [
    {
      "info": {
        "name": "Contact Roles",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Get Associated Contact Roles",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/:module/:dealId/Contact_Roles",
            "params": [
              {
                "name": "module",
                "value": "",
                "type": "path",
                "description": "The module name for the deal record"
              },
              {
                "name": "dealId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the deal record"
              },
              {
                "name": "fields",
                "value": "",
                "type": "query",
                "description": "Comma-separated list of field names to include in the response. Field names must follow API naming conventions."
              }
            ]
          },
          "docs": "Retrieve contact roles associated with a deal"
        },
        {
          "info": {
            "name": "Add Or Update Contact Role Relations",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "{{baseUrl}}/:module/:dealId/Contact_Roles",
            "params": [
              {
                "name": "module",
                "value": "",
                "type": "path",
                "description": "The module name for the deal record"
              },
              {
                "name": "dealId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the deal record"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Add contact roles to a deal or update existing contact role relations in bulk"
        },
        {
          "info": {
            "name": "Delete Contact Role Relations",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "{{baseUrl}}/:module/:dealId/Contact_Roles",
            "params": [
              {
                "name": "module",
                "value": "",
                "type": "path",
                "description": "The module name for the deal record"
              },
              {
                "name": "dealId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the deal record"
              },
              {
                "name": "ids",
                "value": "",
                "type": "query",
                "description": "Comma-separated list of contact role relation IDs to delete"
              }
            ]
          },
          "docs": "Remove one or more contact role associations from a deal using their relation IDs"
        },
        {
          "info": {
            "name": "Get Contact Role For Contact",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/:module/:dealId/Contact_Roles/:contactId",
            "params": [
              {
                "name": "module",
                "value": "",
                "type": "path",
                "description": "The module name for the deal record"
              },
              {
                "name": "dealId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the deal record"
              },
              {
                "name": "contactId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the contact record"
              },
              {
                "name": "fields",
                "value": "",
                "type": "query",
                "description": "Comma-separated list of field names to include in the response. Field names must follow API naming conventions."
              }
            ]
          },
          "docs": "Retrieve the contact role relation for a specific contact associated with a deal."
        },
        {
          "info": {
            "name": "Associate Contact Role To Deal",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "{{baseUrl}}/:module/:dealId/Contact_Roles/:contactId",
            "params": [
              {
                "name": "module",
                "value": "",
                "type": "path",
                "description": "The module name for the deal record"
              },
              {
                "name": "dealId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the deal record"
              },
              {
                "name": "contactId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the contact record"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Assign or update a contact role for a specific contact on a deal."
        },
        {
          "info": {
            "name": "Delete Contact Role Relation",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "{{baseUrl}}/:module/:dealId/Contact_Roles/:contactId",
            "params": [
              {
                "name": "module",
                "value": "",
                "type": "path",
                "description": "The module name for the deal record"
              },
              {
                "name": "dealId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the deal record"
              },
              {
                "name": "contactId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the contact record"
              }
            ]
          },
          "docs": "Remove a specific contact-deal relation using the contact identifier in the path."
        }
      ]
    }
  ],
  "bundled": true
}