users

Sets a single custom user property by email. If value is null or not provided, the property will be set to an empty string.

post/v1/users/set-custom-property

Request

  • Base URL: https://api.memberspot.de (the document declares no server; this is the origin it was published from)
  • URL: https://api.memberspot.de/v1/users/set-custom-property
  • Auth: API key in header X-API-KEY

Request body

emailstring email required

User email

keystring required

The key/id of the custom property to set or remove

valuestring nullable

The value to set for the custom property. If null or not provided, the property will be set to an empty string.

Example request

{
  "email": "user@example.com",
  "key": "property-id-123",
  "value": "some-value"
}

Response

Returns updated user with all custom properties. <br> If user does not exist, a bad request exception will be thrown. <br> If the property does not exist in the school, a bad request exception will be thrown. <br> If the value is invalid for the property type, a bad request exception will be thrown.

uidstring required

User identifier

emailstring required

User email

createdstring date-time required

Date user was created

firstnamestring required

Users firstname

namestring required

Users lastname

activeboolean

Is user active

customUserPropertiesobject

Custom user properties key value pairs

Changes

No recorded changes to this operation across all 1 revision of this API.