Preview

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

createAccount

Create a new 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_MANAGER

    Arguments

    input CreateAccountInput! PREVIEW

    Specifies attributes for a new marketplace account (company)

    CreateAccountInput fields

    name String!

    Name of the account

    countryCode String!

    Country code of the account

    contactPhoneNumber PhoneNumber

    Phone number of the account in E164 format

    contactEmail EmailAddress

    Email address of the account

    website String

    The URL for the account's website

    defaultRole AccountMembershipRole

    Default role given to new members of the account

    vanityUrl Url

    Vanity url

    redirectUrl String

    Redirect Url

    idpId String

    UUID of the identity provider that the user will always use to log in

    externalId String

    Unique external identifier of the account

    accessTypes [AccountAccessType!]

    The type of access that members of this account (company) have

    firstUser FirstUserInput! PREVIEW

    The input required to specify or define the first user of the account.

    allowLogin Boolean

    Optional. Default is "true". When set to "true", the marketplace company allows users, including the first user, to login to the marketplace and receive emails from the marketplace. Users can purchase and assign products within the company. Products can also be purchased on their behalf, and assigned to them. When set to "false", the marketplace company does not allow company members, including the first user, to login to the marketplace or receive email notifications from the marketplace. Products are purchased and assigned on users behalf, and they access those products directly through the product interface.

    status AccountStatus

    Current status of the account

    resellerAccountId String

    Reseller company uuid to associate with customer company. If not provided, then reseller association will not be done

    customAttributes [AccountCustomAttributeInput!]

    The custom attributes associated with the account

    contactAddress AccountContactAddressInput PREVIEW

    The contact address of an account (that is, a company)

    billingDayOfMonth Int

    Billing day of month

    companySize AccountSize

    The company size

    thirtyDaysPurchaseLimitExempt Boolean

    Exempt company from monthly spend limit

    thirtyDaysPurchaseLimitOverrideAmt BigDecimal PREVIEW

    Overrides monthly spend limit of company above monthly spend limit of marketplace

    dailyPurchaseLimitExempt Boolean

    Exempt company from daily spend limit

    dailyPurchaseLimitOverrideAmt BigDecimal PREVIEW

    Overrides daily spend limit of company above daily spend limit of marketplace

    dailyPurchaseLimit BigDecimal PREVIEW

    Daily spend limit of marketplace

    thirtyDaysPurchaseLimit BigDecimal PREVIEW

    Monthly spend limit of marketplace

    dailyPurchaseRemainingAmt BigDecimal PREVIEW

    Daily remaining spending amount

    thirtyDaysPurchaseRemainingAmt BigDecimal PREVIEW

    Monthly remaining spending amount

    Return Fields

    account Account PREVIEW
    userErrors [CreateAccountError!] 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.