Enspace
  1. Members
Enspace
  • Introduction
  • Authentication
  • Concepts
  • First Steps
  • Workspaces
    • Types
      • Fields
        • List Fields
        • Create Field
        • Get Field
        • Field Updated
        • Delete Field
      • Items
        • List Items
        • Create Item
        • Count Items
        • Get Item
        • Update Item
        • Delete item
      • List Types
      • Count Types
      • Get specific Type
      • Create Type
      • Update Type
      • Delete Type
    • Members
      • List Members
        GET
      • Count Members
        GET
      • Get Member
        GET
      • New Member
        POST
      • Update Member
        PUT
      • Remove Member
        DELETE
    • Roles
      • List roles
      • Create role
      • Get specific job title
      • Count positions
      • Update job title
      • Delete role
      • List Role Permissions
      • Add Permission to Role
      • Remove Role Permission
    • Member Groups
      • List groups
      • New group
      • Get group
      • Update group
      • Delete group
      • Add Users
      • Remove Users
    • List Workspaces
      GET
    • Workspace Context
      GET
    • New Workspace
      POST
    • Leave the workspace
      POST
    • Workspace Statistics
      GET
    • Workspace Deletion Preview
      GET
    • Delete Workspace
      DELETE
  • User
    • Audit Logs
      GET
    • List API Keys
      GET
  1. Members

New Member

Em teste
Develop Env
https://api-develop.enspace.io
Develop Env
https://api-develop.enspace.io
POST
https://api-develop.enspace.io
/ws/members
Responsável:Não configurado

Add Member to Workspace#

Adds a new user as a member of the current workspace.

Request Body#

FieldTypeRequiredDescription
emailstringYesEmail of the user to be added
typestringYesMember type: full, standard, or viewer
rolenumberNoID of the role
mgroupsarrayNoIDs of the groups the member will be linked to (deprecated)
fnamestringNoFirst name of the user to be added
lnamestringNoLast name of the user to be added
v1_compatibilitybooleanNoEnables v1 interface compatibility

Type Validations#

owner: Only 1 allowed per workspace
viewer: Read-only access

v1 Compatibility Mode#

When v1_compatibility=true:
✅ Allowed types: full, standard
❌ Blocked types: owner, viewer
🔓 full member will have full access (ignores role)
📋 standard member will be limited only by groups

Request Example#

{
  "email": "new.user@company.com",
  "type": "standard"
}

Response#

Returns the created member object with status 201.

Special Behaviors#

If the user does not exist in the system, it will be automatically created
The user will receive an invitation email for the workspace
If already a member, returns 409 (conflict)

Error Codes#

400 - Invalid data or type not allowed in v1 mode
403 - No permission to add members
409 - User is already a member or owner limit exceeded
422 - Invalid role or non-existing groups

Requisição

Authorization
API Key
Adicionar parâmetro em header
x-api-key
Exemplo:
x-api-key: ********************
API Key
Adicionar parâmetro em header
en-workspace
Exemplo:
en-workspace: ********************
or
Parâmetros Bodyapplication/json

Examples

Respostas

🟢200OK
application/json
Member successfully added
Body

🟠400Invalid request
🟠401Unauthorized
🟠409Conflict
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://api-develop.enspace.io/ws/members' \
--header 'x-api-key: <api-key>' \
--header 'en-workspace: <api-key>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "email": "rafaela.franco@bol.com.br",
    "fname": "Rafaela",
    "lname": "Franco",
    "type": "full"
}'
Response Response Example
200 - Success
{
    "email": "juca@homail.com",
    "type": "full",
    "mgroups": [
        300
    ],
    "role": 3
}
Página anterior
Get Member
Próxima página
Update Member
Built with