Skip to main content

App

Stored in the apps collection. createdAt and updatedAt are maintained automatically.

Returned by GET /apps, PUT /apps, DELETE /apps/brevo, DELETE /apps/elasticemail, GET /apps/facebook/apps/:id, GET /apps/facebook/sync/form-leads/:id and 17 more.

FieldTypeNotes
companyObjectId -> Company
defaultSMTPServerobject
defaultSMTPServer.isGlobalbooleandefault true
defaultSMTPServer.idObjectId
defaultSMTPServer.typestringdefault Smtp · one of Smtp, Gmail, Ses, Sendgrid, Postmark, Brevo, Sparkpost, Elasticemail and 1 more
defaultSMTPServer.customFromNamestring
defaultSMTPServer.customFromEmailstring
defaultSMTPServer.customFromNameBoolbooleandefault false
defaultSMTPServer.customFromEmailBoolbooleandefault false
defaultS3Bucket.isGlobalbooleandefault true
defaultS3Bucket.appObjectId -> Bucket
defaultOcr.isGlobalbooleandefault true
defaultOcr.appObjectId -> Ocr
defaultFacebook.appObjectId -> FacebookApp
defaultFacebook.accessTokenstring
defaultFacebook.accessTokenVerifiedbooleandefault false
defaultFacebook.pagesObjectId[] -> Pagedefault []
defaultRazorpayObjectId -> Razorpay
defaultPhonepeObjectId -> Phonepe
defaultPaypalObjectId -> Paypal
defaultStripeObjectId -> Stripe
defaultPayuObjectId -> Payu
defaultGemini.isGlobalbooleandefault true
defaultGemini.appObjectId -> Gemini
defaultOpenAI.isGlobalbooleandefault true
defaultOpenAI.appObjectId -> OpenAI
defaultClaude.isGlobalbooleandefault true
defaultClaude.appObjectId -> Claude
defaultOffline.isGlobalbooleandefault true
defaultOffline.appObjectId -> OfflineLocation
defaultZoom.isGlobalbooleandefault true
defaultZoom.appObjectId -> ZoomAccount
defaultGoogleCalendar.isGlobalbooleandefault true
defaultGoogleCalendar.appObjectId -> GoogleCalendarAccount
defaultInstagram.isGlobalbooleandefault true
defaultInstagram.appObjectId -> InstagramApp
defaultManualPayment.isGlobalbooleandefault true
defaultManualPayment.appObjectId -> ManualPayment
defaultFacebookOAuthApp.isGlobalbooleandefault true
defaultFacebookOAuthApp.appObjectId -> FacebookOAuthApp
defaultWhatsAppOAuthApp.isGlobalbooleandefault true
defaultWhatsAppOAuthApp.appObjectId -> WhatsAppOAuthApp
pendingWhatsAppOAuth.statestring
pendingWhatsAppOAuth.providerObjectId -> WhatsAppOAuthApp
pendingWhatsAppOAuth.redirectPathstring
pendingWhatsAppOAuth.createdAtdate
uniqueKeystringdefault email · one of email, contactNumber
companyTypestringdefault product · one of product, service, both
defaultCompanyTypestringdefault product · one of product, service
unifiedKeyChangedAtdatedefault null
_idObjectIddefault "6a95712f932657988a91c027"
createdAtdateset once
updatedAtdate