Workspaces

Add a member to a workspace using an invite code

Changed on Nov 13, 2026

Adds a member to the workspace using a short-lived invite code generated by GET /v2/workspaces/members/code. The invited user is identified by the user ID embedded in the code; the caller specifies the member's role (view, manager, maintain, admin).

Up to the plan's per-workspace member cap. The workspace owner cannot be invited to their own workspace.

Rate limited to 1 addition every 5s per user.

post/v2/workspaces/members

Request

Base URL
https://api.squarecloud.app
Auth
API key in header Authorization
TypeScript
https://skmtc.dev/squarecloud/apis/square-cloud-api/docs/v2/workspaces/members/post.ts
A function with typed inputs. Its response is checked against the schema.

Request body

workspaceIdstring required

codestring required

Invite code (UUID v4 without hyphens) from /v2/workspaces/members/code.

group'view' | 'manager' | 'maintain' | 'admin' required

Response

Member added.

status'success' required

Changes

Nov 13, 2026e363e004303c Revision changes
- warning
  added the new SNAPSHOTS_UNAVAILABLE enum value to the //// response property for the response status
- warning
  added the new SNAPSHOTS_UNAVAILABLE enum value to the //// response property for the response status
- warning
  added the new SNAPSHOTS_UNAVAILABLE enum value to the //// response property for the response status
- warning
  added the new SNAPSHOTS_UNAVAILABLE enum value to the //// response property for the response status
- warning
  added the new SNAPSHOTS_UNAVAILABLE enum value to the //// response property for the response status
- warning
  added the new SNAPSHOTS_UNAVAILABLE enum value to the //// response property for the response status
- warning
  added the new SNAPSHOTS_UNAVAILABLE enum value to the //// response property for the response status
- warning
  added the new SNAPSHOTS_UNAVAILABLE enum value to the //// response property for the response status
Nov 2, 20264cf53a0d5577 Revision changes
- warning
  added the new WRITE_FAILED enum value to the //// response property for the response status
- warning
  added the new WRITE_FAILED enum value to the //// response property for the response status
- warning
  added the new WRITE_FAILED enum value to the //// response property for the response status
- warning
  added the new WRITE_FAILED enum value to the //// response property for the response status
- warning
  added the new WRITE_FAILED enum value to the //// response property for the response status
- warning
  added the new WRITE_FAILED enum value to the //// response property for the response status
- warning
  added the new WRITE_FAILED enum value to the //// response property for the response status
- warning
  added the new WRITE_FAILED enum value to the //// response property for the response status
- warning
  added the new WRONG_HOST enum value to the //// response property for the response status
- warning
  added the new WRONG_HOST enum value to the //// response property for the response status
- warning
  added the new WRONG_HOST enum value to the //// response property for the response status
- warning
  added the new WRONG_HOST enum value to the //// response property for the response status
- warning
  added the new WRONG_HOST enum value to the //// response property for the response status
- warning
  added the new WRONG_HOST enum value to the //// response property for the response status
- warning
  added the new WRONG_HOST enum value to the //// response property for the response status
- warning
  added the new WRONG_HOST enum value to the //// response property for the response status

Operation history (8 revisions)

Add a member to a workspace using an invite code

Request

Request body

Response 200OK

Changes

Response