Preview

createAccountMembership is in Preview status and is subject to change without notice. For more information about Preview status, see the GraphQL API policy.

createAccountMembership

Add a new or existing user as a member of a marketplace account (company)

This page contains

    Authorization Rules

    This request requires authorization with at least one of the following scopes:

    Scopes

    ROLE_CHANNEL_ADMIN

    ROLE_CHANNEL_SUPPORT

    ROLE_CORPORATE_ADMIN

    ROLE_PARTNER

    ROLE_SALES_SUPPORT

    ROLE_RESELLER

    ROLE_SYS_ADMIN

    Arguments

    input CreateAccountMembershipInput! PREVIEW

    Specifies the attributes required to add a user as a member of an account (company)

    CreateAccountMembershipInput fields

    accountId ID!

    The unique identifier of the account (company)

    creatorUserId ID

    The unique identifier of the user who is inviting a new user to join an account

    roles [AccountMembershipRole!]

    The roles to be granted to the new user within the account

    firstName String

    User's first name

    lastName String

    User's last name

    idpId String

    The unique identifier of the external identity provider that this user is associated with

    externalId String

    External identifier of the user

    username String

    Username of the user

    email String

    Email address of the user

    sendInvitation Boolean

    Whether this user is to be sent an invitation to join the account, or is instead assigned to the account immediately

    locale Locale

    The user's locale. This combines the standard ISO 639-1 language code and ISO 3166-1 country code format. For example, 'en_US' or 'fr_CA'.

    Return Fields

    accountMembership AccountMembership PREVIEW
    userErrors [CreateAccountMembershipError!] PREVIEW

    Interactive example

    This is an example mutation query. Use the embedded interactive tool below to edit the query.

    Hint: use Ctrl + Space for autocompleting fields.