Api Documentation

Users

Users are the members that will stay in-the-loop through Bundeling. A user can be bound to a Customer through the customer_id field. When retrieving users, the picture field contains an ID that can be used in the FILES endpoint. Posting or updating user pictures is also done through the FILES endpoint. Please refer to the documentation of said endpoint for more information. The label field is only visible to API keys that do not require user authentication.
listWithout user authenticationWith user authenticationchevron_right
Retrieves a collection of users and information about them.
singleWithout user authenticationWith user authenticationchevron_right
Retrieves a single user and information about him/her.
createWithout user authenticationchevron_right
Creates a new user. Only available to API keys without user authentication.
updateWithout user authenticationWith user authenticationchevron_right
Updates a user. API keys without user authentication can update all users. API keys that require user authentication can only update the current user.
deleteWithout user authenticationchevron_right
Deletes a single user. Only available to API keys without user authentication.
Json
XML
PUT https://api.bundeling.com/V2/users

Parameters

Url

NameDescriptionType
uuidA unique identifier used to identify a user. This field is not required for API keys that requires user authentication, because the ID will default to the current user.string

Body

NameDescriptionTypeNillable
customer_uuidA unique identifier used to identify the customer that the user will be bound to. This field is available to API keys without user authentication.stringtrue
usernameA unique username that will be used during user login. This field is only available to API keys without user authentication.stringfalse
passwordA password that will be used during user login. This field is only available to API keys without user authentication.stringfalse
firstnameThe first name of the userstringfalse
nameThe (sur)name of the userstringfalse
genderThe gender of the user
Accepted values: male, female, (empty string)
stringfalse
functionThe function the user fulfills in a companystringfalse
birthdayThe date of birth of the user in YYYY-MM-DD formatdatetrue
emailThe unique email address of the user. This address will be used when sending the invitation emailstringfalse
telephoneThe users phone numberstringfalse
mobilephoneThe users mobile phone numberstringfalse
additional_infoAdditional information, like an introduction text.stringfalse
extra_field_1Optional extra profile fieldstringfalse
extra_field_2Optional extra profile fieldstringfalse
extra_field_3Optional extra profile fieldstringfalse
extra_field_4Optional extra profile fieldstringfalse
twitter_profileThe twitter urlstringfalse
facebook_profileThe facebook urlstringfalse
linkedin_profileThe linkedin urlstringfalse
notesAdditional notes for Club Managers.stringfalse
external_referenceReference for linking to external systems.stringfalse
hiddenHides this user in the app.booleanfalse
deactivatedDeactivates this user in the app.booleanfalse
send_inviteSetting this value to true will send an email to this user with login credentials.booleanfalse
labelsThe labels linked to the user. This field is only available to API keys without user authentication.array(string)false

Example request

Headers

Content-Type:application/json
Api-Key:RAegSX8yZfEbqSPM

Body

{
    "customer_uuid": "d7743aaf53224e279853c7d0c1dbfb3a",
    "username": "johndoe",
    "password": "johndoe123!",
    "firstname": "John",
    "name": "Doe",
    "gender": "Male",
    "function": "Employee",
    "birthday": "1986-04-22",
    "email": "johndoe@email.com",
    "telephone": "+31412345678",
    "mobilephone": "+31612345678",
    "additional_info": "My hobbies are...",
    "extra_field_1": false,
    "extra_field_2": false,
    "extra_field_3": false,
    "extra_field_4": false,
    "twitter_profile": "https://www.twitter.com/eric-van-den-brand-a4769a/",
    "facebook_profile": "https://www.facebook.com/eric-van-den-brand-a4769a/",
    "linkedin_profile": "https://www.linkedin.com/in/eric-van-den-brand-a4769a/",
    "notes": "Lorem ipsum dolor sit amet, consectetur adipiscing elit...",
    "external_reference": "123908",
    "hidden": false,
    "deactivated": false,
    "send_invite": false,
    "labels": [
        "eeb763c41c054dcc8f6d9362f24ee9b2"
    ]
}

Example response

{
    "uuid": "eeb763c41c054dcc8f6d9362f24ee9b2",
    "customer_uuid": "d7743aaf53224e279853c7d0c1dbfb3a",
    "username": "johndoe",
    "firstname": "John",
    "surname": "Doe",
    "name": "John Doe",
    "gender": "male",
    "function": "Employee",
    "birthday": "1986-04-22",
    "email": "johndoe@email.com",
    "telephone": "+31412345678",
    "mobilephone": "+31612345678",
    "additional_info": "Lorem ipsum dolor sit amet, consectetur adipiscing elit...",
    "facebook": "https://www.facebook.com/BundelingApp/",
    "twitter": "https://twitter.com/bundelingapp",
    "linkedin": "https://www.linkedin.com/in/eric-van-den-brand-a4769a/",
    "picture": "LCJwYeyJjbGllbnQiOjEwXRoIjoidXNlcnNcLzE1XC91...",
    "notes": "Lorem ipsum dolor sit amet, consectetur adipiscing elit...",
    "external_reference": "123908",
    "hidden": false,
    "deactivated": false,
    "labels": [
        "56f9e6a8e64f4fb3a98a10e14af918d2",
        "21f84db96e6e4febbcd2010bc26ea07a"
    ],
    "metadata": {
        "name": "value"
    },
    "creationdate": "2024-01-20T00:00:00+0100",
    "lastupdate": "2024-01-20T00:00:00+0100"
}