Users

Access to the Whispir API, the Whispir platform and its features is strictly limited by the user permission set. A user needs proper permissions to access all the features provided by the platform and, when using the API, have appropriate permissions to modify their own user attributes or those of other users in their company workspaces.

The Whispir API provides the /users endpoint for managing the users of the platform. You can:

  • Retrieve users of a workspace.
  • Add new users.
  • Modify user status (except their own).
  • Modify user information.
  • Delete users.

A user's ability to access the features is limited to the STATUS they are assigned. They can have only one status at a time, and the change of status is controlled by the ‘user state machine’. The state machine follows these rules:

User status

PENDING (P)

The user has just been created and is therefore given the default status of Pending.

This status can be modified to:

  • INACTIVE
  • DELETED

INACTIVE (I)

The user has been set to Inactive status. During this state they CANNOT access the platform until their status is set to Active.

This status can be modified to:

  • ACTIVE
  • DELETED

Important! If you’re the user who’s changing your own status, be aware that setting yourself to Inactive results in you being locked out of your own account. Always use another account in your company to change your own account status.

SUSPENDED (B)

The user has been suspended. In this state they can access the platform, but can't use the features.

This status can be modified to:

  • ACTIVE
  • DELETED

DELETED (D)

The user has been deleted. This is a soft delete – they're marked as deleted but their record still exists.

The status can't be modified once it has been set to Deleted.

ACTIVE (A)

The user is active. They can use all the features that they have permission to use on the platform.

This status can be modified to:

  • SUSPENDED
  • DELETED


Example:
If a user has been newly created, the default status is PENDING (P). To activate the user, the user must be set to INACTIVE first via a PUT request and then finally set to ACTIVE (A) via another PUT. They can’t be directly set to (A) from (P).


  • JSON
  • XML

API endpoint

Generic

https://api.<region>.whispir.com/users/?apikey=<your_api_key>
Content-Type: application/vnd.whispir.user-v1+json

    

Resource type

application/vnd.whispir.user-v1+xml
application/vnd.whispir.user-v1+json

   

Methods supported

GET
POST
PUT
DELETE

 

Invalid permission error

If the API user account does not have the permissions needed to operate on a user account, the API will give a 403 Forbidden response. So make sure the account has all the necessary permissions. Log in to the Whispir platform for the region you belong to and manage the permissions.