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

Headers

Header parameters in Requests (User Admin API) apply to this endpoint.

Authorization scopes supported:

ScopeAccess granted
users:writeEntire endpoint

Parameters

userID

Type

Required

Example

StringTrue2f9207ca-8922-4245-bfc5-d8f42939e29a

The user ID of the required user.

Requests

Example Request

curl -L -X PUT "https://***.api.newvoicemedia.com/useradmin/8e22b1fe-d2ea-403d-8c03-50eb21188e79/permissions/interactionPlans" \
-H "Content-Type: application/json" \
-H "Accept: application/vnd.newvoicemedia.v4+json" \
-H "Authorization: Bearer <ACCESS_TOKEN>" \
--data-raw "<JSON BODY>"

Request body parameters

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

Example request body

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

where:

Responses

Successful response

Successful requests return a 200 Success code.