Team Member
Private Team Member API endpoints
List the people who can log into the shop's Subbly admin, ordered by ID. The shop owner is not a team member and is never listed. A member Subbly has banned is listed with active: false.
Query parameters
pageoptionalintegerPage number
per_pageoptionalintegerItems per page
Defaults to 10.
Returnsobject
Team members list response
Error responses
422objectThe page or per_page query parameter failed validation.
Add a person to the shop's team with one role. The plan limits the seats, the owner included, and the roles. The password is emailed to the member, the sent one or one Subbly generates when it is omitted, and is never returned. An email that belongs to an account in no team, such as a removed member or a customer of this shop, reuses that account and overwrites its name, phone and password.
Request body
emailRequiredstringStored in lower case. It must not belong to another account, unless that account is in no team, owns no shop, is not banned and is a customer of no other shop (a removed member or a customer of this shop); that account is then reused.
Format: email.
first_nameRequiredstringlast_nameRequiredstringroleRequiredstringOne of the roles the shop's plan offers.
Possible values: admin, analyst, customer_support, customer_support_manager, designer.
phoneoptionalstring | nullA valid number in international format, with a leading +. Required while team two-factor authentication is on, because members get their login codes by SMS.
passwordoptionalstringEmailed to the member with their username. When it is omitted, Subbly generates one and emails that instead.
ReturnsTeamMember
Team member object response
Error responses
400objectEvery seat of the plan is taken. The seats count the shop's active users, the owner included.
422objectValidation failed, for example the email is invalid or belongs to another account, the role is not on the shop's plan, or the phone is missing while team two-factor authentication is on.
A member of the shop's team. The owner's ID, a removed member and any other account answer 404.
Path parameters
team_member_idRequiredintegerTeam member ID (the ID of their user account)
ReturnsTeamMember
Team member object response
Error responses
404objectThe ID is not a member of this shop's team.
Partially update a team member: only the keys present in the body change. A role change keeps created_at. A sent password is emailed to the member and is never returned.
Path parameters
team_member_idRequiredintegerTeam member ID (the ID of their user account)
Request body
emailoptionalstringStored in lower case. It must not belong to any other account.
Format: email.
first_nameoptionalstringlast_nameoptionalstringroleoptionalstringOne of the roles the shop's plan offers. The member keeps their created_at.
Possible values: admin, analyst, customer_support, customer_support_manager, designer.
phoneoptionalstring | nullA valid number in international format, with a leading +, or null to clear it. null is refused while team two-factor authentication is on.
passwordoptionalstringThe member's new password, emailed to them. It is never returned and cannot be null.
ReturnsTeamMember
Team member object response
Error responses
404objectThe ID is not a member of this shop's team.
422objectValidation failed, for example the email is invalid or belongs to another account, the role is not on the shop's plan, or phone is null while team two-factor authentication is on.
Remove the person from the shop's team and return the member as it was. Their user account is kept, since it may also be a customer account, and the email can be added to the team again later.
Path parameters
team_member_idRequiredintegerTeam member ID (the ID of their user account)
ReturnsTeamMember
The removed team member, serialised as it was just before the removal.
Error responses
404objectThe ID is not a member of this shop's team.