Invite a team member

Invite a member to a workspace by email, with a role and permissions. Owner/admin only.

post/api/v1/workspaces/{workspace_id}/team-members

Path parameters

workspace_idstring required

Example:610a1e660cb41530ca40d372

Request body

role'admin' | 'approver' | 'collaborator' required

membership'team' | 'client'

emailstring email required

permissionsobject

Permission flags + per-platform account-id arrays. Booleans: addBlog, addSocial, addSource, addTopic, viewTeam, postsReview, rescheduleQueue, hasBillingAccess, accessSharedFolder, changeFBGroupPublishAs, approverCanEditPost, approverCanAddNotes, approverCanCreatePost, allow_workflow_management. Arrays: facebook[], instagram[], twitter[], linkedin[], pinterest[], youtube[], tiktok[], threads[], bluesky[], gmb[], telegram[], wordpress[], medium[], shopify[], tumblr_blogs[], tumblr_profiles[], content_categories[].

Example request

{
  "role": "collaborator",
  "membership": "team",
  "email": "member@example.com",
  "permissions": {
    "addSocial": true,
    "postsReview": true,
    "facebook": [
      "298745546665028"
    ],
    "content_categories": [
      "625d06734ceb636c2f5e7743"
    ]
  }
}

Response

Invitation(s) sent

Changes

No recorded changes to this endpoint across all 1 revision of this API.