Skip to main content
PATCH
/
api
/
v1
/
users
/
{id}
/
update-roles
{
  "@context": "<string>",
  "@id": "<string>",
  "@type": "<string>",
  "id": 123,
  "firstName": "<string>",
  "lastName": "<string>",
  "email": "jsmith@example.com",
  "newEmailRequested": "jsmith@example.com",
  "status": "<string>",
  "dateBirth": "2023-11-07T05:31:56Z",
  "gender": "<string>",
  "dateUpdated": "2023-11-07T05:31:56Z",
  "dateCreated": "2023-11-07T05:31:56Z",
  "localCenter": {
    "@context": "<string>",
    "@id": "<string>",
    "@type": "<string>",
    "isActive": true,
    "stripeAccount": "<string>",
    "localCenterStripeAccount": "<string>",
    "isStripeEligible": true,
    "products": [
      {
        "@context": "<string>",
        "@id": "<string>",
        "@type": "<string>",
        "uuid": "<string>",
        "id": 123,
        "name": "<string>",
        "nameEn": "<string>",
        "productStripeId": "<string>",
        "isExternal": true,
        "productPrices": [
          {
            "@context": "<string>",
            "@id": "<string>",
            "@type": "<string>",
            "id": 123,
            "currency": "<string>",
            "price": 123,
            "name": "<string>",
            "isSubscription": true,
            "isDefault": true,
            "displayNameOnPaymentPage": true,
            "overwriteMonthPeriod": 123,
            "isLifetime": true,
            "isHidden": true,
            "isBundle": true,
            "isBundleMember": true,
            "monthPeriod": 123
          }
        ],
        "hasCustomPriceValue": true,
        "monthPeriod": 1,
        "customMinPrice": 123,
        "hasSubscription": true,
        "hasOneTimePayment": true,
        "cycleDay": 123,
        "cycleMonth": 123,
        "maxDate": "2023-11-07T05:31:56Z",
        "description": "<string>",
        "descriptionEn": "<string>",
        "logo": "<string>",
        "isFee": true,
        "isDonation": true,
        "settings": {
          "tenantLogo": true,
          "showTitle": true,
          "colorSelection": null,
          "colorButton": null,
          "disableSubscribe": false,
          "commentSection": true,
          "newestAndTopDonationSection": true,
          "requireFullAddress": false,
          "disableRegister": false,
          "lightThemeOnly": false,
          "isThankYouSingular": false
        },
        "descriptionInternal": "<string>",
        "cycleRecurrences": 123,
        "hasConfidentialityEnabled": true,
        "customMaxPrice": 123,
        "event": "https://example.com/",
        "startingDate": "2023-11-07T05:31:56Z",
        "productOptions": [
          {
            "@context": "<string>",
            "@id": "<string>",
            "@type": "<string>",
            "id": 123,
            "name": "<string>",
            "isArchived": true
          }
        ],
        "type": "<string>",
        "hasLocalCenterOption": true,
        "displayOnProfile": true,
        "productPriceVariations": [
          "https://example.com/"
        ],
        "metaGraphImage": "<string>",
        "heroVideoUrl": "<string>",
        "thankYouMessage": "<string>",
        "descriptionDe": "<string>"
      }
    ],
    "feeProduct": {
      "@context": "<string>",
      "@id": "<string>",
      "@type": "<string>",
      "uuid": "<string>",
      "id": 123,
      "name": "<string>",
      "nameEn": "<string>",
      "productStripeId": "<string>",
      "isExternal": true,
      "productPrices": [
        {
          "@context": "<string>",
          "@id": "<string>",
          "@type": "<string>",
          "id": 123,
          "currency": "<string>",
          "price": 123,
          "name": "<string>",
          "isSubscription": true,
          "isDefault": true,
          "displayNameOnPaymentPage": true,
          "overwriteMonthPeriod": 123,
          "isLifetime": true,
          "isHidden": true,
          "isBundle": true,
          "isBundleMember": true,
          "monthPeriod": 123
        }
      ],
      "hasCustomPriceValue": true,
      "monthPeriod": 1,
      "customMinPrice": 123,
      "hasSubscription": true,
      "hasOneTimePayment": true,
      "cycleDay": 123,
      "cycleMonth": 123,
      "maxDate": "2023-11-07T05:31:56Z",
      "description": "<string>",
      "descriptionEn": "<string>",
      "logo": "<string>",
      "isFee": true,
      "isDonation": true,
      "settings": {
        "tenantLogo": true,
        "showTitle": true,
        "colorSelection": null,
        "colorButton": null,
        "disableSubscribe": false,
        "commentSection": true,
        "newestAndTopDonationSection": true,
        "requireFullAddress": false,
        "disableRegister": false,
        "lightThemeOnly": false,
        "isThankYouSingular": false
      },
      "descriptionInternal": "<string>",
      "cycleRecurrences": 123,
      "hasConfidentialityEnabled": true,
      "customMaxPrice": 123,
      "event": "https://example.com/",
      "startingDate": "2023-11-07T05:31:56Z",
      "productOptions": [
        {
          "@context": "<string>",
          "@id": "<string>",
          "@type": "<string>",
          "id": 123,
          "name": "<string>",
          "isArchived": true
        }
      ],
      "type": "<string>",
      "hasLocalCenterOption": true,
      "displayOnProfile": true,
      "productPriceVariations": [
        "https://example.com/"
      ],
      "metaGraphImage": "<string>",
      "heroVideoUrl": "<string>",
      "thankYouMessage": "<string>",
      "descriptionDe": "<string>"
    },
    "feeDefaultProductPrice": {
      "@context": "<string>",
      "@id": "<string>",
      "@type": "<string>",
      "id": 123,
      "currency": "<string>",
      "price": 123,
      "name": "<string>",
      "isSubscription": true,
      "isDefault": true,
      "displayNameOnPaymentPage": true,
      "overwriteMonthPeriod": 123,
      "isLifetime": true,
      "isHidden": true,
      "isBundle": true,
      "isBundleMember": true,
      "monthPeriod": 123
    },
    "isOnlinePaymentFeeEligible": true,
    "alias": "<string>",
    "isParent": true,
    "id": 123,
    "name": "<string>",
    "parent": {
      "@context": "<string>",
      "@id": "<string>",
      "@type": "<string>",
      "id": 123,
      "name": "<string>",
      "isRoleGroup": true
    },
    "isRoleGroup": true
  },
  "localCenterParent": {
    "@context": "<string>",
    "@id": "<string>",
    "@type": "<string>",
    "id": 123,
    "name": "<string>",
    "isRoleGroup": true
  },
  "townFrom": {
    "@context": "<string>",
    "@id": "<string>",
    "@type": "<string>",
    "id": 123,
    "name": "<string>",
    "nameWithCounty": "<string>",
    "latitude": 123,
    "longitude": 123,
    "country": {
      "@context": "<string>",
      "@id": "<string>",
      "@type": "<string>",
      "id": 123,
      "name": "<string>"
    }
  },
  "type": {
    "@context": "<string>",
    "@id": "<string>",
    "@type": "<string>",
    "id": 123,
    "name": "<string>",
    "namePlural": "<string>",
    "unitType": {
      "@context": "<string>",
      "@id": "<string>",
      "@type": "<string>",
      "name": "<string>",
      "namePlural": "<string>",
      "discriminator": "<string>",
      "isLocal": true,
      "parentUnitType": {},
      "hasUserType": true
    },
    "position": 123,
    "isUserType": true,
    "options": [
      "<string>"
    ],
    "isLocalCenter": true,
    "isLocalCenterParent": true,
    "isNational": true,
    "permissions": [
      "<string>"
    ],
    "chartName": "<string>"
  },
  "userRoles": [
    {
      "@context": "<string>",
      "@id": "<string>",
      "@type": "<string>",
      "id": 123,
      "role": {
        "@context": "<string>",
        "@id": "<string>",
        "@type": "<string>",
        "id": 123,
        "name": "<string>",
        "namePlural": "<string>",
        "unitType": {
          "@context": "<string>",
          "@id": "<string>",
          "@type": "<string>",
          "name": "<string>",
          "namePlural": "<string>",
          "discriminator": "<string>",
          "isLocal": true,
          "parentUnitType": {},
          "hasUserType": true
        },
        "position": 123,
        "isUserType": true,
        "options": [
          "<string>"
        ],
        "isLocalCenter": true,
        "isLocalCenterParent": true,
        "isNational": true,
        "permissions": [
          "<string>"
        ],
        "chartName": "<string>"
      },
      "unit": {
        "@context": "<string>",
        "@id": "<string>",
        "@type": "<string>",
        "id": 123,
        "name": "<string>",
        "isRoleGroup": true
      },
      "dateCreated": "2023-11-07T05:31:56Z",
      "dateEnded": "2023-11-07T05:31:56Z",
      "isAdmin": true
    }
  ],
  "age": 123,
  "fullName": "<string>",
  "isFeeActive": true,
  "isExpiredValidFeeDate": true,
  "isActive": true,
  "timezone": "<string>",
  "customFieldValues": [
    {
      "@context": "<string>",
      "@id": "<string>",
      "@type": "<string>",
      "id": 123,
      "field": {
        "@context": "<string>",
        "@id": "<string>",
        "@type": "<string>",
        "id": 123,
        "name": "<string>",
        "isOnlyAdmin": true
      },
      "value": "<string>"
    }
  ],
  "townCurrent": {
    "@context": "<string>",
    "@id": "<string>",
    "@type": "<string>",
    "id": 123,
    "name": "<string>",
    "nameWithCounty": "<string>",
    "latitude": 123,
    "longitude": 123,
    "country": {
      "@context": "<string>",
      "@id": "<string>",
      "@type": "<string>",
      "id": 123,
      "name": "<string>"
    }
  },
  "mainRole": {
    "@context": "<string>",
    "@id": "<string>",
    "@type": "<string>",
    "id": 123,
    "role": {
      "@context": "<string>",
      "@id": "<string>",
      "@type": "<string>",
      "id": 123,
      "name": "<string>",
      "namePlural": "<string>",
      "unitType": {
        "@context": "<string>",
        "@id": "<string>",
        "@type": "<string>",
        "name": "<string>",
        "namePlural": "<string>",
        "discriminator": "<string>",
        "isLocal": true,
        "parentUnitType": {},
        "hasUserType": true
      },
      "position": 123,
      "isUserType": true,
      "options": [
        "<string>"
      ],
      "isLocalCenter": true,
      "isLocalCenterParent": true,
      "isNational": true,
      "permissions": [
        "<string>"
      ],
      "chartName": "<string>"
    },
    "unit": {
      "@context": "<string>",
      "@id": "<string>",
      "@type": "<string>",
      "id": 123,
      "name": "<string>",
      "isRoleGroup": true
    },
    "dateCreated": "2023-11-07T05:31:56Z",
    "dateEnded": "2023-11-07T05:31:56Z",
    "isAdmin": true
  },
  "logo": "<string>",
  "phoneNumber": "<string>",
  "profileWebsite": "<string>",
  "profileFacebook": "<string>",
  "profileTwitter": "<string>",
  "profileLinkedin": "<string>",
  "profileInstagram": "<string>",
  "profileTelegram": "<string>",
  "dateJoined": "2023-11-07T05:31:56Z",
  "familyNth": "<string>",
  "isFullMember": true,
  "isTrainer": true,
  "cardId": "<string>",
  "professionIndustry": {
    "@context": "<string>",
    "@id": "<string>",
    "@type": "<string>",
    "id": 123,
    "translation": [
      "<string>"
    ]
  },
  "professionHeadline": "<string>",
  "validFeeDate": "2023-11-07T05:31:56Z",
  "validLocalFeeDate": "2023-11-07T05:31:56Z",
  "lastCardPrintedDate": "2023-11-07T05:31:56Z",
  "feeLocalProductPrice": {
    "@context": "<string>",
    "@id": "<string>",
    "@type": "<string>",
    "id": 123,
    "currency": "<string>",
    "price": 123,
    "name": "<string>",
    "isSubscription": true,
    "isDefault": true,
    "displayNameOnPaymentPage": true,
    "overwriteMonthPeriod": 123,
    "isLifetime": true,
    "isHidden": true,
    "isBundle": true,
    "isBundleMember": true,
    "monthPeriod": 123
  },
  "feeTenantProductPrice": {
    "@context": "<string>",
    "@id": "<string>",
    "@type": "<string>",
    "id": 123,
    "currency": "<string>",
    "price": 123,
    "name": "<string>",
    "isSubscription": true,
    "isDefault": true,
    "displayNameOnPaymentPage": true,
    "overwriteMonthPeriod": 123,
    "isLifetime": true,
    "isHidden": true,
    "isBundle": true,
    "isBundleMember": true,
    "monthPeriod": 123
  },
  "language": "<string>",
  "isSupporter": true,
  "identity": {
    "@context": "<string>",
    "@id": "<string>",
    "@type": "<string>",
    "id": 123,
    "isValidated": true,
    "hasUploadedDocument": true
  },
  "adhesion": {
    "@context": "<string>",
    "@id": "<string>",
    "@type": "<string>",
    "id": 123,
    "isValidated": true,
    "isSuccess": true,
    "isRejected": true,
    "hasUploadedDocument": true,
    "status": "pending"
  },
  "postalCode": "<string>",
  "address": "<string>",
  "phoneCountry": "<string>",
  "phoneLocalNumber": "<string>",
  "dateJoinedFullMember": "2023-11-07T05:31:56Z",
  "educationStatus": "<string>",
  "educationPhd": {
    "@context": "<string>",
    "@id": "<string>",
    "@type": "<string>",
    "id": 123,
    "translation": [
      "<string>"
    ]
  },
  "educationMaster": {
    "@context": "<string>",
    "@id": "<string>",
    "@type": "<string>",
    "id": 123,
    "translation": [
      "<string>"
    ]
  },
  "educationUniversity": {
    "@context": "<string>",
    "@id": "<string>",
    "@type": "<string>",
    "id": 123,
    "translation": [
      "<string>"
    ]
  },
  "professionJob": {
    "@context": "<string>",
    "@id": "<string>",
    "@type": "<string>",
    "id": 123,
    "isJob": true,
    "isExpertise": true,
    "translation": [
      "<string>"
    ],
    "name": "<string>"
  },
  "professionExpertise": {
    "@context": "<string>",
    "@id": "<string>",
    "@type": "<string>",
    "id": 123,
    "isJob": true,
    "isExpertise": true,
    "translation": [
      "<string>"
    ],
    "name": "<string>"
  },
  "professionSector": "<string>",
  "professionExpertiseOther": "<string>",
  "isRegisterAsMember": true,
  "professionOrganisation": "<string>",
  "professionOrganisationRole": "<string>",
  "companyIdentifier": "<string>",
  "companyName": "<string>",
  "companyAddress": "<string>",
  "companyRegNo": "<string>",
  "isExpiredValidLocalFeeDate": true,
  "isLocalFeeActive": true,
  "profileTiktok": "<string>"
}

Path Parameters

​
id
string
required

User identifier

Body

application/merge-patch+json

The updated User resource

​
firstName
string | null
​
lastName
string | null
​
newEmailRequested
string<email> | null
​
status
string
​
dateBirth
string<date-time> | null
​
gender
string | null
​
townFrom
string<iri-reference> | null
Example:

"https://example.com/"

​
plainPassword
string
​
tenant
string<iri-reference> | null
Example:

"https://example.com/"

​
timezone
string | null
​
townCurrent
string<iri-reference> | null
Example:

"https://example.com/"

​
mainRole
string<iri-reference> | null
Example:

"https://example.com/"

​
phoneNumber
string | null
​
profileWebsite
string | null
​
profileFacebook
string | null
​
profileTwitter
string | null
​
profileLinkedin
string | null
​
profileInstagram
string | null
​
profileTelegram
string | null
​
dateJoined
string<date-time> | null
​
isFullMember
boolean | null
​
isTrainer
boolean | null
​
cardId
string | null
​
professionIndustry
string<iri-reference> | null
Example:

"https://example.com/"

​
professionHeadline
string | null
​
lastCardPrintedDate
string<date-time> | null
​
feeLocalProductPrice
string<iri-reference> | null
Example:

"https://example.com/"

​
feeTenantProductPrice
string<iri-reference> | null
Example:

"https://example.com/"

​
language
string | null
​
hasDigestDaily
boolean | null
​
postalCode
string | null
​
address
string | null
​
phoneCountry
string | null
​
dateJoinedFullMember
string<date-time> | null
​
educationStatus
string | null
​
professionJob
string<iri-reference> | null
Example:

"https://example.com/"

​
professionExpertise
string<iri-reference> | null
Example:

"https://example.com/"

​
professionSector
string | null
​
professionExpertiseOther
string | null
​
privacy
string[] | null
Example:
{
  "age": true,
  "name": false,
  "email": true,
  "phone": true,
  "social": false,
  "image": false,
  "town": false,
  "profession": false
}
​
notificationSettings
string[] | null
Example:
{
  "prefTheme": "light",
  "prefWelcomeRead": false,
  "pPrivacyRead": false,
  "pGroups": false,
  "pNotificationRead": false,
  "pTimezoneRead": false,
  "pAdhesionRead": false
}
​
professionOrganisation
string | null
​
professionOrganisationRole
string | null
​
hasDigestWeekly
boolean | null
​
companyIdentifier
string | null
​
companyName
string | null
​
companyAddress
string | null
​
companyRegNo
string | null
​
mfaEnabled
boolean | null
​
profileTiktok
string | null

Response

User resource updated

​
@context
​
@id
string
​
@type
string
​
id
integer
​
firstName
string | null
​
lastName
string | null
​
email
string<email> | null
​
newEmailRequested
string<email> | null
​
status
string
​
dateBirth
string<date-time> | null
​
gender
string | null
​
dateUpdated
string<date-time>
​
dateCreated
string<date-time>
​
localCenter
object | null
​
localCenterParent
object | null
​
townFrom
object | null
​
type
object | null
​
userRoles
object[]
​
age
integer | null
​
fullName
string
​
isFeeActive
boolean
​
isExpiredValidFeeDate
boolean
​
isActive
boolean | null
default:true
Example:

true

​
timezone
string | null
​
customFieldValues
object[]
​
townCurrent
object | null
​
mainRole
object | null
​
phoneNumber
string | null
​
profileWebsite
string | null
​
profileFacebook
string | null
​
profileTwitter
string | null
​
profileLinkedin
string | null
​
profileInstagram
string | null
​
profileTelegram
string | null
​
dateJoined
string<date-time> | null
​
familyNth
​
isFullMember
boolean | null
​
isTrainer
boolean | null
​
cardId
string | null
​
professionIndustry
object | null
​
professionHeadline
string | null
​
validFeeDate
string<date-time> | null
​
validLocalFeeDate
string<date-time> | null
​
lastCardPrintedDate
string<date-time> | null
​
feeLocalProductPrice
object | null
​
feeTenantProductPrice
object | null
​
language
string | null
​
isSupporter
boolean | null
​
identity
object | null
​
adhesion
object | null
​
postalCode
string | null
​
address
string | null
​
phoneCountry
string | null
​
phoneLocalNumber
string | null
​
dateJoinedFullMember
string<date-time> | null
​
educationStatus
string | null
​
educationPhd
object | null
​
educationMaster
object | null
​
educationUniversity
object | null
​
professionJob
object | null
​
professionExpertise
object | null
​
professionSector
string | null
​
professionExpertiseOther
string | null
​
isRegisterAsMember
boolean | null
​
professionOrganisation
string | null
​
professionOrganisationRole
string | null
​
companyIdentifier
string | null
​
companyName
string | null
​
companyAddress
string | null
​
companyRegNo
string | null
​
isExpiredValidLocalFeeDate
boolean
​
isLocalFeeActive
boolean
​
profileTiktok
string | null
⌘I