Create or update user (Upsert)
POST {{baseUrl}}/.api/api.svc/apisync/upsert_user
This endpoint can perform the following actions as part of a single call:
- Create or update a member in your digital workplace
- Send the digital workplace's default welcome message to new users via email
- Add the member to user groups
- Revoke an existing member from user groups
The data for this endpoint can be sent one of two ways; either as form data in the body of the call, or as query parameters.
Any field of a user's profile can be updated with this endpoint, as long as the correct field name is included in the form data or parameters. You can find a list of the names of the available fields for your site on the Bulk Member Upload page.
Request Body
[{"name"=>"email", "value"=>"", "datatype"=>"null"}, {"name"=>"firstName", "value"=>"", "datatype"=>"null"}, {"name"=>"lastName", "value"=>"", "datatype"=>"null"}, {"name"=>"password", "value"=>"", "datatype"=>"null"}, {"name"=>"igval_customIdentifier", "value"=>"", "datatype"=>"null"}, {"name"=>"preferredLanguage", "value"=>"", "datatype"=>"null"}, {"name"=>"groupsToAdd", "value"=>"", "datatype"=>"null"}, {"name"=>"groupsToRevoke", "value"=>"", "datatype"=>"null"}, {"name"=>"allowIdChange", "value"=>"", "datatype"=>"null"}, {"name"=>"userId", "value"=>"", "datatype"=>"null"}, {"name"=>"sendWelcomeMessage", "value"=>"", "datatype"=>"null"}]
HEADERS
| Key | Datatype | Required | Description |
| Accept | null | | String (Response type)
Examples: > - application/json > - application/xml
The type of response data to request. Default: application/XML |
RESPONSES
status: OK
{"minRequestPeriod":0,"requestSupportCode":637792511657470875,"dictionary":null,"response":{"__type":"namevalue:http://schemas.iglooplatform.com/Igloo.Old.Common","name":"userId","value":"{{$randomUUID}}"}}