Skip to main content
inputCreateMemberInput

Fields

clientMutationId
String

A unique identifier for the client performing the mutation.

email
String!
required

Email address of the member. An existing account with this address is reused; otherwise a new account is created.

firstName
String!
required

First name of the member.

lastName
String!
required

Last name of the member.

memberType
CreatableMemberType
default:FULL_MEMBER

Tier to create the member at. FULL_MEMBER joins the account to the Network; LIMITED_MEMBER grants it a free plan instead, so it holds only that plan's Spaces and no Network membership. A LIMITED_MEMBER call creates a subscription, so it also requires the host:write:network_plans scope. Default: FULL_MEMBER.

planId
ID

Free Payment Plan that grants the Limited Member's Space access — resource ID or GlobalID. Required when memberType is LIMITED_MEMBER, and rejected otherwise. Must be an active free subscription plan that grants at least one Space and does not include the Network. A call naming it also requires the host:write:network_plans scope.

role
MembershipRole
default:CONTRIBUTOR

Role the new member holds on the Network. Applies to FULL_MEMBER only. Default: CONTRIBUTOR.

sendWelcomeEmail
Boolean
default:true

Email the new member a welcome carrying a sign-in link. A Limited Member receives the plan's welcome email, which carries no sign-in link. Default: true.