Skip to main content
PATCH
/
v2
/
users
Bulk Patch Users
curl --request PATCH \
  --url https://api.studio.prisme.ai/v2/users \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "query": {
    "ids": [
      "<string>"
    ],
    "emails": [
      "<string>"
    ]
  },
  "data": {
    "firstName": "<string>",
    "lastName": "<string>",
    "email": "jsmith@example.com",
    "meta": {},
    "platformRole": "<string>",
    "groups": [
      "<string>"
    ],
    "groupAcls": {}
  }
}
'
{
  "requestedCount": 123,
  "matchedCount": 123,
  "modifiedCount": 123
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
query
object
required
data
object
required
behaviour
object

Response

Bulk update result

requestedCount
number

Number of users requested to be updated

matchedCount
number

Number of users found and matched

modifiedCount
number

Number of users actually modified