create_dsr_engagement

Name: create_dsr_engagement

Description: Creates a new Digital Sales Room (DSR) from provided template and request parameters, then returns the created DSR identifier and status metadata. Use this endpoint to provision DSR engagements programmatically as part of guided sales workflows or automated campaign flows.

Schema

{
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "The name of the DSR to be created."
    },
    "templateId": {
      "type": "string",
      "description": "The unique identifier of the template to use for creating the DSR."
    },
    "contexts": {
      "type": "array",
      "description": "Array of contexts of the relevant interaction.",
      "items": {
        "type": "object",
        "properties": {
          "contextId": {
            "type": "string",
            "example": "00646000009eMGL",
            "description": "The id of the context the integrator is in. Typically the record id from the external system."
          },
          "contextName": {
            "type": "string",
            "example": "Edge Communications",
            "description": "The name of the context. Typically this is the record name."
          },
          "contextType": {
            "type": "string",
            "example": "Opportunity",
            "description": "The type or class of the context. Typically the record type such as Account, Contact, or Opportunity. This field is case sensitive."
          },
          "contextEmail": {
            "type": "string",
            "example": "[email protected]",
            "description": "Email associated with the context, if applicable. For example, the email of the contact associated with an opportunity or case."
          },
          "systemId": {
            "type": "string",
            "example": "00566547531rXYZ",
            "description": "The id for the external system which is critical when the tenant can be connected to multiple instances of the same system (such as Salesforce or Dynamics)."
          },
          "systemType": {
            "type": "string",
            "example": "Salesforce",
            "description": "The system type."
          }
        },
        "required": [
          "contextId",
          "contextName",
          "contextType",
          "systemId",
          "systemType"
        ],
        "additionalProperties": false
      }
    }
  },
  "required": [
    "templateId"
  ]
}

{
  "type": "object",
  "properties": {
    "dsrId": {
      "type": "string",
      "description": "The unique identifier of the created DSR."
    }
  },
  "required": []
}