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.
Name | Type |
---|---|
createAcceptedTerm | Create new accept |
createAnAcceptedTerm | Create new accepted terms for anyone required feature |
createAddress | Create an address associated with an entity |
updateAddress | Update an address attributes associated with an entity |
deleteAddress | Delete an address associated with an entity |
createArrivedConfiguration | Create a configuration for arrived |
updateArrivedConfiguration | Update an arrived organization's configuration |
createApplicationAccess | Create a Module of an application |
updateApplicationAccess | Update attributes from module |
deleteApplicationAccess | Delete Application Access |
createApplication | Create an application to making resource requests on behalf of the user with the user's authorization. |
updateApplication | Update an application attributes |
uploadApplicationLogo | Upload an application logo |
deleteApplication | Delete an application |
createArrival | Create an arrival |
updateArrival | Update an arrival |
invalidateCache | Invalidate a model from cache |
updateCharge | Update a charge attributes |
deleteCharge | Delete a charge |
createChargePayment | Create charge payment for entity and user |
deleteChargePayment | Cancel charge payment for entity and user |
createCodeAndSend | Create new code and send |
validateCode | Validate code |
createCommitment | Create a commitment's attributes |
updateCommitment | Update a commitment's attributes |
deleteCommitment | Delete a commitment |
createCommitmentRemind | Create a reminder to specific commitment |
createConfirmAddress | Generate code, save and send |
confirmAddress | Confirm email or phone with code |
createConcierge | Create an concierge associated to an organization |
updateConcierge | Update an concierge attributes |
deleteConcierge | Delete an concierge |
createContract | Create new contract |
createContracts | Create new contracts for multiple entities |
updateContract | Update contract |
createCover | Create a cover for an organization |
deleteCover | Delete a cover from an organization |
updateDailyMessagesRecord | Update number of messages sent in the organization by admins and staff in the given date or from yesterday |
createDevice | Create user's device specification |
updateDevice | Update user's device specification |
deleteDevice | Delete user's device specification |
createEntity | Create an entity in a organization |
updateEntity | Update an entity's attributes |
deleteEntity | Delete an entity and also from organization |
importEntity | Import an entity to organization |
createEntityTemplate | Create an entity based on a existing model |
createExportRequest | Create new export request |
createExternalChannel | Create a External Channel of an application |
updateExternalChannel | Update attributes from a External Channel |
deleteExternalChannel | Delete External Channel |
createExternalChannelEntity | Create externalchannel and entity association |
deleteExternalChannelEntity | Delete externalchannel and entity association |
createFeedback | Create new feedback |
createForm | Create a form |
updateForm | Update a form |
deleteForm | Delete a form |
createFormField | Create a field for a form |
updateFormField | Update a field from a form |
deleteFormField | Delete a field from a form |
deleteFormMessage | Delete form attached to message |
createFormResult | Fill out a form |
createGroup | Create a group in organization |
updateGroup | Update a group's attributes |
deleteGroup | Delete a group |
importChanges | Import organization's changes |
createIntegration | Create a Module of an application |
updateIntegration | Update attributes from module |
deleteIntegration | Delete Module |
createIntegrationContract | Create a Contract of an integration |
updateIntegrationContract | Update attributes from contract |
deleteIntegrationContract | Delete Contract |
cancelIntegrationContract | Cancel contract |
createIntegrationCancellationReason | Create a Contract of an integration |
updateIntegrationCancellationReason | Update attributes from contract |
deleteIntegrationCancellationReason | Delete Contract |
createInvoice | Create new invoice |
updateInvoice | Edit existent invoice |
deleteInvoice | Delete invoice |
payInvoiceManually | Pay invoice manually |
createLabel | Create new label |
updateLabel | Edit existent label |
deleteLabel | Delete label |
createLink | Create an application to making resource requests on behalf of the user with the user's authorization. |
updateLink | Update an application attributes |
deleteLink | Delete an application |
portalLogged | Create a link to portal logged |
createLogo | Create a logo for an organization |
deleteLogo | Delete a logo from an organization |
registerMarketingPQL | |
sendArrivalSlackMQL | Send a message on slack with an Arrival MQL |
createSignedUrl | Create a S3 signed url |
createMediaWithKey | Create media file with key returned from s3 |
createMedia | createMedia is deprecated and should not be used anymore, use uploadMedia instead |
uploadMedia | Create a media with multipart upload |
createMessageDraft | Create a message draft |
updateMessageDraft | Update a message draft |
deleteMessageDraft | Delete a message draft |
createMessageStatus | Create status of message |
createMessageStatusInBatch | Create status of message in batch |
deleteMessageStatus | Delete the status of a message |
deleteMessageStatusInBatch | Delete the status of messages in batch |
createMessage | Create a message |
updateMessage | Update a message |
deleteMessage | Soft delete a message |
notifyPendingMessage | Send a notification to the user informing about a pending message |
createModule | Create a Module of an application |
updateModule | Update attributes from module |
deleteModule | Delete Module |
createReaction | Create a reaction to a message |
deleteReaction | Delete a reaction |
clearAllNotifications | Clear all user's notification |
createOnboarding | Create a Onboarding for an organization |
updateOnboarding | Update attributes from onboarding |
deleteOnboarding | Delete onboarding from organization |
createOauthProvider | Create new register relationed with application |
createOrganizationAccount | |
updateOrganizationAccount | |
deleteOrganizationAccount | |
createOrganizationApplication | Create an organization application relationship |
deleteOrganizationApplication | Delete an organization which is associated with application |
createOrganizationBanner | Create a banner in an organization |
deleteOrganizationBanner | Delete a banner from an organization |
createOrganizationWithdrawal | |
createOrganization | Create an organization |
updateOrganization | Update organization's attributes |
deleteOrganization | Delete an organization |
deleteDemonstration | Delete an organization |
createPicture | Create a picture for an entity |
deletePicture | Delete an picture from an entity |
createPlan | Create new plan |
updatePlan | Edit existent plan |
deletePlan | Delete plan |
createProduct | Create new product |
updateProduct | Edit existent product |
deleteProduct | Delete product |
createProductFeature | |
enableProductFeature | |
launchProductFeature | |
revertLaunchProductFeature | |
updateProductFeature | |
disableProductFeature | |
deleteProductFeature | |
updateRecipient | Update the recipient attributes |
updateRecipientInBatch | Update the recipient attributes in batch |
createReply | Create a reply message |
updateReply | Update a reply message |
deleteReply | Delete reply |
reportDenounce | Reports flags and problems with moments, messages, entitties or events |
createReportField | Create a field for a report |
updateReportField | Update a field from a report |
deleteReportField | Delete a field from a report |
createReport | Create a report |
updateReport | Update a report |
deleteReport | Delete a report |
createRole | Create a role |
deleteRole | Delete a role |
createRule | Create new single rule |
updateRule | update rule |
deleteRule | Delete rule |
deleteSignature | Delete an signature attachment |
createSignatureResult | Mutation that creates a acceptance for a signature |
deleteSignatureResult | Delete a acceptance of a signature attachement |
deleteSignatureResultFromSignature | Delete all acceptances of a signature |
updateSurvey | Update a survey attributes |
deleteSurvey | Delete a survey |
createSurveyResult | Create a survey result |
createTag | Create a Tag for an organization |
updateTag | Update attributes from tag |
deleteTag | Delete tag from organization |
createTerm | Create new term |
updateTerm | Update term |
createTermNotification | Create new term notification |
createUserCard | @TODO DESCRIBE ME |
deleteUserCard | @TODO DESCRIBE ME |
updateUserEntityConfiguration | |
updateUserConciergeFilter | Update concierges that are filtered by user |
updateUserArrivedFilter | Update filters related to arrived from user |
createUserEntity | Create user and entity association |
deleteUserEntity | Delete user and entity association |
createUserEntityTag | Create user, entity and tag association |
deleteUserEntityTag | Delete user, entity and tag association |
createUserVehicle | Creates a new user vehicle |
updateUserVehicle | Updates a user vehicle |
removeDefaultVehicle | Sets the user default vehicle to none |
deleteUserVehicle | Deletes the user vehicle |
undeleteUserVehicle | Undeletes the user vehicle |
recreateUserVehicle | Delete the vehicle and create a new one with given attributes |
createUser | Create an user |
updateUser | Update attribute from user |
deleteUser | Delete user |
createWebhook | Create a Webhook |
updateWebhook | Update attributes from webhook |
deleteWebhook | Delete webhook |
authorizeApplication | Authorize application with |
authorizeMarketplace | Authorize marketplace with |
passwordAuthenticate | Login user based on password |
codeAuthenticate | Login user based on code |
refreshTokenAuthenticate | Login user based on refresh token |
findApplication | Lookup an application by clientId |
findApplications | List of all applications |
findUser | Lookup a user by email or phone, send code if found |
findUsers | List of all users |
findOrganization | Lookup an organization by username |
findOrganizations | List of all organizations |
organizationRequestAccess | Ask organization admins to include addresses in organization |
findChannels | List of consultants |
findAddress | Check if address code and email or phone exist in address table |
testWebSocket |