Mutation
Operações de escrita com GraphQL



Create, Update e Delete

As mutations são descritas como objetos strings no corpo POST da requisição. A sintaxe é composta pelo o nome da função [createEntity] e um objeto INPUT responsável por incluir todos os parametros [Obrigatório & Opicionais]. Os campos de retorno devem ser explicitamente solicitados logo abaixo.


REQUISIÇÃO
{
  createEntity(
    input:{
      organizationId: 1,
      type: "STUDENT",
      fullname: "SKYWALKER"
    }
  )
  {
    entity {
      id
      fullname
    }
  }
}
RETORNO
{
"data": {
  "entity": {
    {
      "id": 1443,
      "fullname": "SKYWALKER",
    }
  }
}

Lista de Mutations

NameType
createAcceptedTermCreate new accept
createAnAcceptedTermCreate new accepted terms for anyone required feature
createAddressCreate an address associated with an entity
updateAddressUpdate an address attributes associated with an entity
deleteAddressDelete an address associated with an entity
createArrivedConfigurationCreate a configuration for arrived
updateArrivedConfigurationUpdate an arrived organization's configuration
createApplicationAccessCreate a Module of an application
updateApplicationAccessUpdate attributes from module
deleteApplicationAccessDelete Module
createApplicationCreate an application to making resource requests on behalf of the user with the user's authorization.
updateApplicationUpdate an application attributes
uploadApplicationLogoUpload an application logo
deleteApplicationDelete an application
createArrivalCreate an arrival
updateArrivalUpdate an arrival
invalidateCacheInvalidate a model from cache
updateChargeUpdate a charge attributes
deleteChargeDelete a charge
createChargePaymentCreate charge payment for entity and user
deleteChargePaymentCancel charge payment for entity and user
createCodeAndSendCreate new code and send
validateCodeValidate code
createCommitmentCreate a commitment's attributes
updateCommitmentUpdate a commitment's attributes
deleteCommitmentDelete a commitment
createCommitmentRemindCreate a reminder to specific commitment
createConfirmAddressGenerate code, save and send
confirmAddressConfirm email or phone with code
createConciergeCreate an concierge associated to an organization
updateConciergeUpdate an concierge attributes
deleteConciergeDelete an concierge
createContractCreate new contract
createContractsCreate new contracts for multiple entities
updateContractUpdate contract
createCoverCreate a cover for an organization
deleteCoverDelete a cover from an organization
updateDailyMessagesRecordUpdate number of messages sent in the organization by admins and staff in the given date or from yesterday
createDeviceCreate user's device specification
updateDeviceUpdate user's device specification
deleteDeviceDelete user's device specification
createEntityCreate an entity in a organization
updateEntityUpdate an entity's attributes
deleteEntityDelete an entity and also from organization
importEntityImport an entity to organization
createEntityTemplateCreate an entity based on a existing model
createExternalChannelCreate a External Channel of an application
updateExternalChannelUpdate attributes from a External Channel
deleteExternalChannelDelete External Channel
createExternalChannelEntityCreate externalchannel and entity association
deleteExternalChannelEntityDelete externalchannel and entity association
createFeedbackCreate new feedback
createFormCreate a form
updateFormUpdate a form
deleteFormDelete a form
createFormFieldCreate a field for a form
updateFormFieldUpdate a field from a form
deleteFormFieldDelete a field from a form
deleteFormMessageDelete form attached to message
createFormResultFill out a form
createGroupCreate a group in organization
updateGroupUpdate a group's attributes
deleteGroupDelete a group
importChangesImport organization's changes
createIntegrationCreate a Module of an application
updateIntegrationUpdate attributes from module
deleteIntegrationDelete Module
createInvoiceCreate new invoice
updateInvoiceEdit existent invoice
deleteInvoiceDelete invoice
payInvoiceManuallyPay invoice manually
createLabelCreate new label
updateLabelEdit existent label
deleteLabelDelete label
createLinkCreate an application to making resource requests on behalf of the user with the user's authorization.
updateLinkUpdate an application attributes
deleteLinkDelete an application
createLogoCreate a logo for an organization
deleteLogoDelete a logo from an organization
createSignedUrlCreate a S3 signed url
createMediaWithKeyCreate media file with key returned from s3
createMediacreateMedia is deprecated and should not be used anymore, use uploadMedia instead
uploadMediaCreate a media with multipart upload
createMessageDraftCreate a message draft
updateMessageDraftUpdate a message draft
deleteMessageDraftDelete a message draft
createMessageStatusCreate status of message
createMessageStatusInBatchCreate status of message in batch
deleteMessageStatusDelete the status of a message
deleteMessageStatusInBatchDelete the status of messages in batch
createMessageCreate a message
updateMessageUpdate a message
deleteMessageSoft delete a message
notifyPendingMessageSend a notification to the user informing about a pending message
createModuleCreate a Module of an application
updateModuleUpdate attributes from module
deleteModuleDelete Module
createReactionCreate a reaction to a message
deleteReactionDelete a reaction
clearAllNotificationsClear all user's notification
createOnboardingCreate a Onboarding for an organization
updateOnboardingUpdate attributes from onboarding
deleteOnboardingDelete onboarding from organization
createOrganizationAccount
updateOrganizationAccount
deleteOrganizationAccount
createOrganizationApplicationCreate an organization application relationship
deleteOrganizationApplicationDelete an organization which is associated with application
createOrganizationWithdrawal
createOrganizationCreate an organization
updateOrganizationUpdate organization's attributes
deleteOrganizationDelete an organization
deleteDemonstrationDelete an organization
createPictureCreate a picture for an entity
deletePictureDelete an picture from an entity
createPlanCreate new plan
updatePlanEdit existent plan
deletePlanDelete plan
createProductCreate new product
updateProductEdit existent product
deleteProductDelete product
updateRecipientUpdate the recipient attributes
updateRecipientInBatchUpdate the recipient attributes in batch
createReplyCreate a reply message
updateReplyUpdate a reply message
deleteReplyDelete reply
reportDenounceReports flags and problems with moments, messages, entitties or events
createReportFieldCreate a field for a report
updateReportFieldUpdate a field from a report
deleteReportFieldDelete a field from a report
createReportCreate a report
updateReportUpdate a report
deleteReportDelete a report
createRoleCreate a role
deleteRoleDelete a role
createRuleCreate new single rule
updateRuleupdate rule
deleteRuleDelete rule
updateSurveyUpdate a survey attributes
deleteSurveyDelete a survey
createSurveyResultCreate a survey result
createTagCreate a Tag for an organization
updateTagUpdate attributes from tag
deleteTagDelete tag from organization
createTermCreate new term
updateTermUpdate term
createTermNotificationCreate new term notification
createUserCard@TODO DESCRIBE ME
deleteUserCard@TODO DESCRIBE ME
updateUserEntityConfigurationUpdate configuration related to the user-entity relationship.
createUserEntityCreate user and entity association
deleteUserEntityDelete user and entity association
createUserEntityTagCreate user, entity and tag association
deleteUserEntityTagDelete user, entity and tag association
createUserVehicleCreates a new user vehicle
updateUserVehicleUpdates a user vehicle
removeDefaultVehicleSets the user default vehicle to none
deleteUserVehicleDeletes the user vehicle
undeleteUserVehicleUndeletes the user vehicle
recreateUserVehicleDelete the vehicle and create a new one with given attributes
createUserCreate an user
updateUserUpdate attribute from user
deleteUserDelete user
createWebhookCreate a Webhook
updateWebhookUpdate attributes from webhook
deleteWebhookDelete webhook
authorizeApplicationAuthorize application with
authorizeMarketplaceAuthorize marketplace with
passwordAuthenticateLogin user based on password
codeAuthenticateLogin user based on code
refreshTokenAuthenticateLogin user based on refresh token
findApplicationLookup an application by clientId
findUserLookup a user by email or phone, send code if found
findUsersList of all users
findOrganizationLookup an organization by username
findOrganizationsList of all organizations
organizationRequestAccessAsk organization admins to include addresses in organization
findChannelsList of consultants
findAddressCheck if address code and email or phone exist in address table
testWebSocket