Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

The PUT /users/{userId}/permissions/interactionPlans endpoint replaces the user’s interaction plan permissions for the user matching the user ID provided.

...

The endpoint requires an interactionPlanPermissions object in JSON format as in the request body.

Example request body

Code Block
languagejs
themeMidnight
{
  "interactionPlanPermissions": [
    {
      "interactionPlanId": "1d75b21f-6d94-4477-9ba7-513a30bfc21d",
      "interactionPlanName": "Main plan"
    },
    {
      "interactionPlanId": "fd6e3099-8673-4b11-865b-2e15ec80911a",
      "interactionPlanName": "Callback plan"
    }
  ]
}

where:

  • interactionPlanPermission. The user’s interaction plan permissions.
    • interactionPlanId. The unique ID of the interaction plan that the user has access to.
    • interactionPlanName. The name of the interaction plan that the user has access to.

Responses

Successful response

Successful requests return a 200 Success code.