Search
K
Yuki Platform API Prod

Update Portal User

This endpoint allows updating a user’s information in the portal using the specified user email and portal ID. The update can modify the user’s name, language preference, and roles. Users attempting to perform this operation need to ensure they possess the necessary permissions. You should have yukiapi:portal:users:write and yukiapi:portal:users:update scopes to access this endpoint.

put
https://apirest.yukiworks.com/api/v1/portals/{portal-id}/users/byEmail

Query Parameters

emailstring(email)required

Email address to search for

Path Parameters

portal-idstringrequired

The portal id

Example:3afb7b54-6144-4561-9a29-1148006f2375

Headers

Authorizationstringrequired

Bearer token for authentication

Content-Typestringrequired

Content type, must be application/json

Allowed values:application/json

Body

application/json

UpdatePortalUser

firstNamestringrequired

First name of the user

lastNamestringrequired

Last name of the user

languagestringrequired

The locale for the domain.
BE: nl-BE, en-US, fr-BE.
NL: en-US, nl-NL

Allowed values:nl-BEen-USfr-BEnl-NL

Example:en-US

rolesarray[string]required

User roles for portal users

Allowed values:PortalAdministratorPortalBackofficePortalBackofficeControllerPortalDataEntry

Response

User successfully updated

  
curl --request PUT \
  --url 'https://apirest.yukiworks.com/api/v1/portals/3afb7b54-6144-4561-9a29-1148006f2375/users/byEmail?email=' \
  --header 'Accept: application/problem+json' \
  --header 'Content-Type: application/json' \
  --data '{
  "firstName": "firstName",
  "lastName": "lastName",
  "language": "en-US",
  "roles": [
    "PortalAdministrator"
  ]
}'
User successfully updated