Magidoc

Mutation
Object

This is the root mutation

Fields

#

addFunds

Non-null

Add funds to the given account. Scope: "host".

createCollective

Create a Collective. Scope: "account".

createEvent

Create an Event. Scope: "account".

createFund

Create a Fund. Scope: "account".

createOrganization

Create an Organization. Scope: "account".

createProject

Create a Project. Scope: "account".

editAccountSetting

Non-null

Edit the settings for the given account. Scope: "account" or "host".

editAccountFeeStructure

Non-null

An endpoint for hosts to edit the fees structure of their hosted accounts. Scope: "host".

editAccountFreezeStatus

Non-null

An endpoint for hosts to edit the freeze status of their hosted accounts. Scope: "host".

createWebAuthnRegistrationOptions

Non-null

Create WebAuthn public key registration request options

addTwoFactorAuthTokenToIndividual

Non-null

Add 2FA to the Individual if it does not have it. Scope: "account".

removeTwoFactorAuthTokenFromIndividual

Non-null

Remove 2FA from the Individual if it has been enabled. Scope: "account".

editTwoFactorAuthenticationMethod

Non-null

Edit 2FA method

editAccount

Non-null

Edit key properties of an account. Scope: "account".

setPolicies

Non-null

Adds or removes a policy on a given account. Scope: "account".

deleteAccount

Adds or removes a policy on a given account. Scope: "account".

sendMessage

Send a message to an account. Scope: "account"

regenerateRecoveryCodes

[ String !]

Regenerate two factor authentication recovery codes

editAccountingCategories

Non-null

Edit an accounting category. Returns the account with the updated categories.

createApplication

updateApplication

deleteApplication

editComment

Edit a comment. Scope: "conversations", "expenses" or "updates".

deleteComment

createComment

Create a comment. Scope: "conversations", "expenses" or "updates".

createConnectedAccount

Connect external account to Open Collective Account. Scope: "connectedAccounts".

deleteConnectedAccount

Delete ConnectedAccount. Scope: "connectedAccounts".

createConversation

Create a conversation. Scope: "conversations".

editConversation

Edit a conversation. Scope: "conversations".

followConversation

Returns true if user is following, false otherwise. Must be authenticated. Scope: "conversations".

addEmojiReaction

Non-null

Add an emoji reaction. Scope: "conversations", "expenses" or "updates".

removeEmojiReaction

Non-null

Remove an emoji reaction. Scope: "conversations", "expenses" or "updates".

createExpense

Non-null

Submit an expense to a collective. Scope: "expenses".

editExpense

Non-null

To update an existing expense

deleteExpense

Non-null

Delete an expense. Only work if the expense is rejected - please check permissions.canDelete. Scope: "expenses".

processExpense

Non-null

Process the expense with the given action. Scope: "expenses".

draftExpenseAndInviteUser

Non-null

Persist an Expense as a draft and invite someone to edit and submit it. Scope: "expenses".

resendDraftExpenseInvite

Non-null

To re-send the invitation to complete a draft expense. Scope: "expenses".

sendGuestConfirmationEmail

Non-null

Sends an email for guest to confirm their emails and create their Open Collective account

confirmGuestAccount

Non-null

Mark an account as confirmed

applyToHost

Non-null

Apply to an host with a collective. Scope: "account".

processHostApplication

Non-null

Reply to a host application. Scope: "host".

removeHost

Non-null

Removes the host for an account

setChangelogViewDate

Non-null

Update the time which the user viewed the changelog updates. Scope: "account".

setNewsletterOptIn

Non-null

Update newsletter opt-in preference. Scope: "account".

setPassword

Non-null

Set password to Individual. Scope: "account". 2FA.

inviteMember

Non-null

Invite a new member to the Collective. Scope: "account".

editMemberInvitation

Edit an existing member invitation of the Collective. Scope: "account".

replyToMemberInvitation

Non-null

Endpoint to accept or reject an invitation to become a member. Scope: "account".

followAccount

Non-null

Follows a given Collective. Scope: "account"

unfollowAccount

Non-null

Unfollows a given Collective. Scope: "account"

editPublicMessage

Non-null

Edit the public message for the given Member of a Collective. Scope: "account".

createMember

Non-null

[Root only] Create a member entry directly. For non-root users, use inviteMember

editMember

Non-null

Edit an existing member of the Collective. Scope: "account".

removeMember

Remove a member from the Collective. Scope: "account".

revokeOAuthAuthorization

Non-null

Revoke an OAuth authorization. Scope: "account".

createOrder

Non-null

To submit a new order. Scope: "orders".

cancelOrder

Cancel an order. Scope: "orders".

updateOrder

Update an Order's amount, tier, or payment method. Scope: "orders".

updateOrderAccountingCategory

Non-null

Update the accounting category of an order. Scope: "orders".

confirmOrder

Non-null

Confirm an order (strong customer authentication). Scope: "orders".

processPendingOrder

Non-null

A mutation for the host to approve or reject an order. Scope: "orders".

moveOrders

[ Order ]!
Non-null

[Root only] A mutation to move orders from one account to another

createPaymentIntent

Non-null

Creates a Stripe payment intent

createPendingOrder

Non-null

To submit a new order. Scope: "orders".

editPendingOrder

Non-null

To edit a pending order. Scope: "orders".

addCreditCard

Non-null

Add a new payment method to be used with an Order. Scope: "orders".

confirmCreditCard

Non-null

Confirm a credit card is ready for use after strong customer authentication. Scope: "orders".

createSetupIntent

Non-null

Creates a Stripe setup intent

addStripePaymentMethodFromSetupIntent

Non-null

Adds a Stripe payment method

createPayoutMethod

Create a new Payout Method to get paid through the platform. Scope: "expenses".

removePayoutMethod

Non-null

Remove the given payout method. Scope: "expenses".

editAccountFlags

Non-null

[Root only] Edits account flags (deleted, banned, archived, trusted host)

editAccountType

Non-null

[Root only] Edits account type from User to Organization

clearCacheForAccount

Non-null

[Root only] Clears the cache for a given account

mergeAccounts

Non-null

[Root only] Merge two accounts, returns the result account

banAccount

Non-null

[Root only] Ban accounts

moveExpenses

Non-null

[Root only] A mutation to move expenses from one account to another

setTaxForm

[Root only] A mutation to set the tax from for an account.

refundTransaction

Refunds a transaction. Scope: "transactions".

rejectTransaction

Non-null

Rejects transaction, removes member from Collective, and sends a message to the contributor. Scope: "transactions".

createUpdate

Non-null

Create update. Scope: "updates".

editUpdate

Non-null

Edit update. Scope: "updates".

publishUpdate

Non-null

Publish update. Scope: "updates".

unpublishUpdate

Non-null

Unpublish update. Scope: "updates".

deleteUpdate

Non-null

Delete update. Scope: "updates".

uploadFile

Non-null

assignNewVirtualCard

Non-null

Assign Virtual Card information to existing hosted collective. Scope: "virtualCards".

createVirtualCard

Non-null

Create new Stripe Virtual Card for existing hosted collective. Scope: "virtualCards".

editVirtualCard

Non-null

Edit existing Virtual Card information. Scope: "virtualCards".

requestVirtualCard

Request Virtual Card to host. Scope: "virtualCards".

rejectVirtualCardRequest

Non-null

Reject a virtual card request. Scope: "virtualCards"

pauseVirtualCard

Non-null

Pause active Virtual Card. Scope: "virtualCards".

resumeVirtualCard

Non-null

Resume paused Virtual Card. Scope: "virtualCards".

deleteVirtualCard

Delete Virtual Card. Scope: "virtualCards".

createWebhook

Create webhook. Scope: "webhooks".

updateWebhook

Update webhook. Scope: "webhooks".

deleteWebhook

Delete webhook. Scope: "webhooks".

setEmailNotification

Set email notification subscription for requesting logged-in user

editTier

Non-null

Edit a tier.

createTier

Non-null

Create a tier.

deleteTier

Non-null

Delete a tier.

createPersonalToken

Non-null

updatePersonalToken

Non-null

deletePersonalToken

updateSocialLinks

Non-null

Updates collective social links

setTags

Non-null

addAgreement

Non-null

Add an agreement for the given host account. Scope: "host".

editAgreement

Non-null

Edit an agreement for the given host account. Scope: "host".

deleteAgreement

Non-null

Delete an agreement for the given host account. Scope: "host".

createVendor

Non-null

Create a new vendor for given host

editVendor

Non-null

Edit an existing vendor

deleteVendor

Non-null

Delete a vendor

convertOrganizationToVendor

Non-null

Convert an organization to a vendor

sendSurveyResponse

Send In-App Survey response