All guides
User

Teams

Manage workspace membership and the access assigned to members.

Step-by-step guide

Before you start

Use the account and workspace that own the records. This page does not include administrator configuration forms.

Open this feature

Open /portal/teams/stream on your application domain, or use the matching item in the application menu.

Steps

Join workspace

  1. Open /portal/teams on your own application domain.
  2. Complete these fields in that form: Invite code. Their choices and limits are listed below.
  3. Select Join workspace. The exact label can change between creating and editing a record.
  4. If validation fails, correct the named field and submit again. After success, reopen the same record and compare the saved values.
Field shown in the formWhat to enterExample / note
Invite codeRequired.Use the value required by the task; no example is assumed.

Save settings

  1. Open /portal/teams on your own application domain.
  2. Complete these fields in that form: Team name, Description. Their choices and limits are listed below.
  3. Select Save settings. The exact label can change between creating and editing a record.
  4. If validation fails, correct the named field and submit again. After success, reopen the same record and compare the saved values.
Field shown in the formWhat to enterExample / note
Team nameRequired. No more than 255 characters.Test record (use a unique value where required).
DescriptionOptional, unless this form asks for it. No more than 2000 characters.A short description of this test record.

Create invitation

  1. Open /portal/teams on your own application domain.
  2. Complete these fields in that form: Email address (optional), Role, Message (optional), Expires on (defaults to 7 days). Their choices and limits are listed below.
  3. Select Create invitation. The exact label can change between creating and editing a record.
  4. If validation fails, correct the named field and submit again. After success, reopen the same record and compare the saved values.
Field shown in the formWhat to enterExample / note
Email address (optional)Optional, unless this form asks for it. Use an email address you control for a test. No more than 255 characters.Use your controlled test inbox.
RoleRequired. Choose one of the options shown by the form.Use the value appropriate to your test account; no preset is supplied.
Message (optional)Optional, unless this form asks for it. No more than 1000 characters.Use the value required by the task; no example is assumed.
Expires on (defaults to 7 days)Optional, unless this form asks for it.Use the value required by the task; no example is assumed.

Fields shown in the interface

Only fields traced to this role’s handler and its own view are listed. The application can show separate create/edit forms; do not fill every row on one screen.

Form 1 — fields shown in the interface
FieldWhat to enter or choose
Invite codeRequired.
Team nameRequired. No more than 255 characters.
DescriptionOptional, unless this form asks for it. No more than 2000 characters.
Email address (optional)Optional, unless this form asks for it. Use an email address you control for a test. No more than 255 characters.
RoleRequired. Choose one of the options shown by the form.
Message (optional)Optional, unless this form asks for it. No more than 1000 characters.
Expires on (defaults to 7 days)Optional, unless this form asks for it.

Check the result

After a source-checked procedure, verify the same record in the same workspace. Check saved values, visible state and access with the intended test account. An external payment/message/provider action needs its own result check.

Problems and validation

ProblemNext step
A field rejects the valueCheck its named error, the form’s visible choices and the relevant limit. Do not substitute internal numeric codes for the displayed options.
The control is missingCheck role, plan, enabled app and current record state. Do not grant administrator access merely to complete a User task.
The saved result is unexpectedReopen the same record and verify its owner/workspace before repeating the action.

Messages defined for this screen

MessageWhat to review
This invite code is invalid or has expired.Check the related field or action in this role’s form.
This invitation belongs to another email address. Sign in with the invited email.Check the related field or action in this role’s form.
This team has reached the maximum member limit for its current plan.Check the related field or action in this role’s form.

Technical reference

Role-scoped source references

Pinned commit: ca125291cce57358ac4842e50928bc31fc6eab07

Source-only route information
MethodSource-default route
GET/portal/teams/stream
GET/portal/teams/switch
LIVEWIRE/portal/teams
LIVEWIRE/portal/teams/join/{inviteCode}
Unmapped fields — not user instructions

These fields belong to this role’s source handler, but their screen labels were not confirmed.

Source keyHandler
enabled_modulesmodules/AppTeams/Livewire/Workspace.php
invite_permissionsmodules/AppTeams/Livewire/Workspace.php
inviteManagedAccountsmodules/AppTeams/Livewire/Workspace.php
conversation_titlemodules/AppTeams/Livewire/Workspace.php
conversation_descriptionmodules/AppTeams/Livewire/Workspace.php
initial_messagemodules/AppTeams/Livewire/Workspace.php
bodymodules/AppTeams/Livewire/Workspace.php
edit_conversation_titlemodules/AppTeams/Livewire/Workspace.php
edit_conversation_descriptionmodules/AppTeams/Livewire/Workspace.php