Skip to main content
PATCH
/
users-organizations
/
v1
/
rs
/
users
/
{userId}
Update user organization
curl --request PATCH \
  --url https://z52mnqg347.execute-api.eu-west-3.amazonaws.com/main/users-organizations/v1/rs/users/{userId} \
  --header 'Authorization: Bearer <token>' \
  --header 'content-type: <content-type>' \
  --header 'x-session-token: <x-session-token>' \
  --data '
{
  "firstName": "John",
  "lastName": "Doe",
  "professionId": 1,
  "scope": 1
}
'
{
  "data": {
    "userId": 1,
    "organizationId": 1,
    "scope": 1,
    "permissions": {
      "group": 1,
      "read": [
        1,
        2
      ],
      "manage": [
        1,
        2
      ]
    },
    "deletedAt": "2024-12-15T10:00:00.000Z",
    "updatedAt": "2024-12-09T14:23:00.000Z",
    "createdAt": "2024-01-15T08:45:00.000Z"
  }
}

Authorizations

Authorization
string
header
required

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

Headers

content-type
string
required

Content type, must be "application/json".

Allowed value: "application/json"
x-session-token
string
required

Session token used for authenticating the request.

Example:

"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiIxMjM0NTY3ODkwIiwic2Vzc2lvbklkIjoiYWJjZGVmMTIzNDU2IiwiaWF0IjoxNjA1MDk3ODk5LCJleHAiOjE2MDUxODQyOTl9.4XRQ1iXDyvEj5LgPZHbmTmzOZs98M3YPOzgf3MhxjaI"

Path Parameters

userId
required

Unique identifier of the user or "me" to refer to the authenticated user.

Required range: -9007199254740991 <= x <= 9007199254740991
Example:

"me"

Body

application/json

Details required to update user organization

firstName
string

First name of the profile.

Maximum string length: 250
Example:

"John"

lastName
string

Last name of the profile.

Maximum string length: 250
Example:

"Doe"

permissions
object
professionId
integer

Unique identifier of the label.

Required range: -9007199254740991 <= x <= 9007199254740991
Example:

1

scope
enum<number>

Role of the user in the organization.

Available options:
1,
2
Example:

1

Response

200 - application/json

The user organization has been updated

data
object
required