Organization Member Management
If you are not the only person to be acting in the context of your organization (either sending out invites to tenants as a real estate manager or managing account opening requests as a product provider), you can invite team members to your organization.
TIP: For the system roles available, please refer to Glossary, Terms & Concepts.
Authenticate
As for all calls, please set up authentication before and send the bearer token with all requests.
Obtain authorization using the Client Credentials Grant flow of OAuth 2.0.
Follow the instructions under Setup OAuth App to create an OAuth App and get client_id and client_secret.
The API key's user needs to have the system role 'owner' of the organization in order to perform the member management actions.
- post:
/v1/user/auth/token
For all subsequent API calls, include the following header: Authorization: Bearer <access_token>.
View current members
To get an overview who is already part of your team and with which role they are registered, use the following call:
- GET:
/v1/organization/{organizationSlug}/members
Add a member
To a add a member to your organization, you send the user an invite. They need to accept the invite before the membership is active.
You can invite any email to join your organization. If they do not have an account on Zinsli yet, they will be invited to create one.
To create the invitation, you need their name, email and the role you would like to give them.
Invites can only be accepted by the email address to which the invite was addressed.
- POST:
/v1/organization/{organizationSlug}/invite-member
TIP: To cancel an invite which has not yet been accepted, use /v1/organization/{organizationSlug}/invitation/cancel. After the invite has been accepted, you need to remove the user from the organization.
Modify a current member
You can only change the system role of a current team member. You cannot change the email of a user. (To change the email, the user needs to complete the change in their own profile. To change the membership to a different email, delete the unwanted user and create an invitation for the new user).
- PATCH:
/v1/organization/{organizationSlug}/member/{id}
Provide the new role in the body. (See docu for available roles.)
Remove a member
To remove a member from the team, use the 'delete' call. Note: you are only removing the user from your organization, you are not deleting their account.
- DELETE:
/v1/organization/{organizationSlug}/member/{id}