API Reference

Update an active, existing user in Bonusly. If a user already exists with the
specified userName the API will return a 409.

  • Parameters:
    • userName (string, required) - A unique identifier for the user. This will
      be imported into Bonusly as the user's email
      .
    • name.givenName (string, optional) - This will be imported into Bonusly as
      the user's firstName
      .
    • name.familyName (string, optional) - This will be imported into Bonusly as
      the user's lastName
      .
    • addresses.country (string, optional) - This will be imported into Bonusly as
      the user's country when addresses.type is work
      .
    • externalId (string, optional) - This will be imported into Bonusly as the user's
      external_unique_id
      .
    • urn:scim:schemas:extension:enterprise:1.0.department (string, optional) -
      This will be imported into Bonusly as the user's department custom property.
    • urn:scim:schemas:extension:bonusly:1.0:User.location (string, optional) -
      This will be imported into Bonusly as the user's location custom property.
    • urn:scim:schemas:extension:bonusly:1.0:User.employee_id (string, optional) -
      This will be imported into Bonusly as the user's employee_id custom property.
    • urn:scim:schemas:extension:bonusly:1.0:User.role (string, optional) -
      This will be imported into Bonusly as the user's role custom property.
    • urn:scim:schemas:extension:bonusly:1.0:User.job_title (string, optional) -
      This will be imported into Bonusly as the user's job_title custom property.
    • urn:scim:schemas:extension:bonusly:1.0:User.division (string, optional) -
      This will be imported into Bonusly as the user's division custom property.
    • urn:scim:schemas:extension:bonusly:1.0:User.business_unit (string, optional) -
      This will be imported into Bonusly as the user's business_unit custom property.
      This will be imported into Bonusly as the user's user_mode - defaults to "normal", can be "benefactor" or "receiver".
    • urn:scim:schemas:extension:bonusly:1.0:User.manager_email (string, optional) -
      This will be imported into Bonusly as the user's manager_email - this will set the user's manager to the existing user with the matching e-mail address.
    • urn:scim:schemas:extension:bonusly:1.0:User.hired_on (string, optional) - format: YYYY-MM-DD
      This will be imported into Bonusly as the user's hired_on.
    • urn:scim:schemas:extension:bonusly:1.0:User.date_of_birth (string, optional) - format: YYYY-MM-DD.
      This will be imported into Bonusly as the user's date_of_birth. Bonusly only stores the month and day. The year will be stripped.
Language
Credentials
Click Try It! to start a request and see the response here!