Overview

Updates an existing user’s details in CleverTap, including roles, teams, and account access. Use this endpoint to modify a user’s configuration across one or more accounts. This is a complete update operation, existing values are replaced with those in the request body.

HTTP Method

PUT

Endpoint

/nx/v2/scim/v2/Users/{email}

Base URL

The following is an example base URL for a CleverTap account in the United States region:

https://<clevertap_domain>/nx/v2/scim/v2/Users/{email}

Example: https://us1.dashboard.clevertap.com/nx/v2/scim/v2/Users/{email}

🚧

Region-Specific

The CleverTap domain is environment- and region-specific. Do not copy the example URL directly. Always replace <clevertap_domain> with the domain for your region. Refer Region for more details.

Authentication

This endpoint requires Bearer token authentication. Include the token in the Authorization header for all requests.

Required Headers

The following headers must be included with every API request:

Replace <SCIM_TOKEN> with a valid SCIM Bearer token generated from the CleverTap dashboard. Refer to Generate SCIM Token for API-Based Provisioning.

Path Parameters

The following is the path parameter and its description:

Example Request

The following is the sample request:

curl -X PUT https://<clevertap_domain>/nx/v2/scim/v2/Users/{email}
-H "Authorization: Bearer <SCIM_TOKEN>"
-H "Content-Type: application/scim+json"
{
  "name": {
    "givenName": "John",
    "familyName": "Doe-Smith"
  },
  "active": true,
  "invitedBy": "[email protected]",
  "accounts": [
    {
      "accountId": "CLEVERTAP_ACCOUNT_ID",
      "roles": "Editor",
      "teams": "Marketing,Engineering,Product",
      "status": "Active"
    },
    {
      "accountId": "CLEVERTAP_ACCOUNT_ID",
      "roles": "Editor",
      "teams": "Marketing,Engineering,Product",
      "status": "Revoke"
    }
  ]
}

Request Parameters

The following table lists the request parameters:

🚧

Important

• All fields in the request body replace existing values (full update, not partial)

Example Response

The following is the sample response:

{
  "id": "user-unique-id",
  "userName": "[email protected]",
  "name": {
    "givenName": "John",
    "familyName": "Doe-Smith"
  },
  "active": true,
  "accounts": [
    {
      "accountId": "CLEVERTAP_ACCOUNT_ID",
      "roles": "Editor",
      "teams": "Marketing,Engineering,Product",
      "status": "Active"
    },
    {
      "accountId": "CLEVERTAP_ACCOUNT_ID",
      "roles": "Editor",
      "teams": "Marketing,Engineering,Product",
      "status": "Revoke"
    }
  ],
  "invitedBy": "[email protected]"
}

Response Parameters

The following table lists the response parameters returned by the API.

Error Codes

All errors follow the SCIM v2.0 error schema and return standard HTTP status codes.

Supported Status Values