SUsurense
Workflows

Create a workflow

Create a new workflow. Can be linked to leads, employers, and products.

post/workflows

Request

  • Base URL
    https://api.surense.com/api/v1
  • URL
    https://api.surense.com/api/v1/workflows
  • Auth
    OAuth 2
    Client credentials
    Token URL: https://api.surense.com/oauth/token scopes: workflows:create

Request body

agencyIdstring uuid

Agency ID

templateIdstring uuid

Identifies the template to use to create the workflow

typeIdstring uuid required

Workflow type ID

customerIdstring uuid required

Customer ID

leadIdstring uuid

Lead ID

employerIdstring uuid

Employer ID

ownerIdstring uuid required

Owner ID

assignedUserIdstring uuid

Assigned user ID

dueAtstring date-time

Due date and time

dueAtTimeSetboolean

Whether due time is set

dueDatestring date

Due date (deprecated - use dueAt instead)

dueTimestring

Due time (deprecated - use dueAt instead)

productIdstring uuid

Product ID

Example request

{
  "agencyId": "123e4567-e89b-12d3-a456-426614174000",
  "templateId": "123e4567-e89b-12d3-a456-426614174000",
  "typeId": "123e4567-e89b-12d3-a456-426614174000",
  "customerId": "123e4567-e89b-12d3-a456-426614174000",
  "leadId": "123e4567-e89b-12d3-a456-426614174000",
  "employerId": "123e4567-e89b-12d3-a456-426614174000",
  "ownerId": "123e4567-e89b-12d3-a456-426614174000",
  "assignedUserId": "123e4567-e89b-12d3-a456-426614174000",
  "dueAt": "2024-12-31T23:59:59Z",
  "dueAtTimeSet": true,
  "dueDate": "2024-12-31",
  "dueTime": "23:59:59",
  "productId": "123e4567-e89b-12d3-a456-426614174000"
}

Response

OK

tenantIdstring uuid
agencyIdstring uuid
createdDatestring date-time
createdBystring uuid
creatorNamestring
lastModifiedDatestring date-time
lastModifiedBystring uuid
versioninteger
idstring uuid
numberinteger
parentWorkflowIdstring uuid
parentWorkflowNumberinteger
leadIdstring uuid
leadNumberinteger
leadSourceIdstring uuid
documentCountinteger
ownerIdstring uuid
ownerNamestring
assigneeIdstring uuid
assigneeNamestring
assignedUserIdstring uuid
assignedUserNamestring
assignedAtstring date-time
assignedBystring uuid
typeIdstring uuid
typeNamestring
statusIdstring uuid
statusNamestring
statusSuccessboolean
statusRejectboolean
statusClosedboolean
statusDatestring date-time
lastStatusUpdateBystring uuid
priorityinteger
successDatestring date-time
openDatestring date
closedDatestring date
dueDatestring date
dueTimestring
dueAtstring date-time
dueAtTimeSetboolean
overduePeriodstring
customerIdstring uuid
customerManagerIdstring uuid
customerManagersstring[]
customerIdType1 | 2 | 3 | 4 | 5 | 6

Customer Identity Type:<br/>1 - ת.ז<br/>2 - דרכון<br/>3 - רישיון נהיגה<br/>4 - אחר<br/>5 - ח.פ<br/>6 - ח.צ

customerIdNumberstring
customerFirstNamestring
customerLastNamestring
customerFullNamestring
customerNamestring
customerFullNameReversestring
customerNameReversestring
customerCellNumberstring
customerPhoneNumberstring
customerEmailstring
customerEmailBounceboolean
customerOtherEmailstring
customerStatusIdstring uuid
customerClassIdstring uuid
customerSourceIdstring uuid
customerGender1 | 2 | 3

Gender:<br/>1 - לא מוגדר<br/>2 - זכר<br/>3 - נקבה

customerDeathboolean
currentProductType1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 | 29 | 30 | 31 | 32 | 33 | 34 | 35 | 36 | 37 | 38 | 39 | 40 | 41 | 42 | 43 | 44 | 45 | 46

Product Type:<br/>1 - קרן פנסיה חדשה מקיפה<br/>2 - קרן פנסיה ותיקה<br/>3 - קופת גמל לתגמולים ופיצויים<br/>4 - קופת גמל להשקעה<br/>5 - חיסכון לכל ילד<br/>6 - מנהלים חיסכון טהור<br/>7 - קרן השתלמות<br/>8 - ביטוח מנהלים<br/>9 - ביטוח רכב<br/>10 - ביטוח דירה<br/>11 - ביטוח סיעודי<br/>12 - ביטוח בריאות<br/>13 - ביטוח חיים<br/>14 - ביטוח חיים משכנתא<br/>15 - אבדן כושר עבודה<br/>16 - כתב שירות<br/>17 - ביטוח חיים ואכ"ע<br/>18 - ביטוח עסק<br/>19 - קרן פנסיה חדשה כללית<br/>20 - ביטוח נסיעות לחו"ל<br/>21 - ביטוח מחלות קשות<br/>22 - אבדן כושר עבודה קולקטיבי<br/>23 - ביטוח בריאות קולקטיבי<br/>24 - ביטוח מבנה משכנתא<br/>25 - ביטוח דירה תכולה<br/>26 - ביטוח דירה מבנה ותכולה<br/>27 - מטריה ביטוחית<br/>28 - ביטוח רכב צד ג'<br/>29 - ביטוח רכב מקיף<br/>30 - ביטוח רכב חובה וצד ג'<br/>31 - ביטוח רכב חובה ומקיף<br/>32 - ביטוח תאונות אישיות<br/>33 - ביטוח מוות מתאונה<br/>34 - ביטוח שיניים<br/>35 - ביטוח חיים נכות<br/>36 - ביטוח חיים קולקטיבי<br/>37 - לא ידוע<br/>38 - ביטוח סיעודי קבוצתי<br/>39 - ביטוח חיים ואכ"ע קבוצתי<br/>40 - איחוד קופות<br/>41 - פוליסת חיסכון פיננסי<br/>42 - השקעות אלטרנטיביות<br/>43 - קופת גמל מרכזית לפיצויים<br/>44 - תיק מנוהל<br/>45 - ביטוח אחריות מקצועית<br/>46 - קופת גמל למטרות אחרות

currentCompanyIdinteger
currentCompanyDisplayNamestring
currentProductIdinteger
currentProductNamestring
currentCompanyContactIdstring uuid
currentCompanyContactFullNamestring
currentCompanyContactRolestring
currentCompanyContactEmail1string
currentCompanyContactEmail2string
currentCompanyContactPhoneNumber1string
currentCompanyContactPhoneNumber2string
currentAccountPolicyNumberstring
currentSubscriptionDatestring date
currentAccumulationnumber
currentDepositFeenumber
currentAccumulationFeenumber
currentProductStatus1 | 2 | 3

Current Product Status:<br/>1 - לא נבחר<br/>2 - פעיל<br/>3 - לא פעיל

currentProductClass1 | 2 | 3

Current Product Class:<br/>1 - לא נבחר<br/>2 - מוצר לא בניהול<br/>3 - מוצר בניהול

newProductType1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 | 29 | 30 | 31 | 32 | 33 | 34 | 35 | 36 | 37 | 38 | 39 | 40 | 41 | 42 | 43 | 44 | 45 | 46

Product Type:<br/>1 - קרן פנסיה חדשה מקיפה<br/>2 - קרן פנסיה ותיקה<br/>3 - קופת גמל לתגמולים ופיצויים<br/>4 - קופת גמל להשקעה<br/>5 - חיסכון לכל ילד<br/>6 - מנהלים חיסכון טהור<br/>7 - קרן השתלמות<br/>8 - ביטוח מנהלים<br/>9 - ביטוח רכב<br/>10 - ביטוח דירה<br/>11 - ביטוח סיעודי<br/>12 - ביטוח בריאות<br/>13 - ביטוח חיים<br/>14 - ביטוח חיים משכנתא<br/>15 - אבדן כושר עבודה<br/>16 - כתב שירות<br/>17 - ביטוח חיים ואכ"ע<br/>18 - ביטוח עסק<br/>19 - קרן פנסיה חדשה כללית<br/>20 - ביטוח נסיעות לחו"ל<br/>21 - ביטוח מחלות קשות<br/>22 - אבדן כושר עבודה קולקטיבי<br/>23 - ביטוח בריאות קולקטיבי<br/>24 - ביטוח מבנה משכנתא<br/>25 - ביטוח דירה תכולה<br/>26 - ביטוח דירה מבנה ותכולה<br/>27 - מטריה ביטוחית<br/>28 - ביטוח רכב צד ג'<br/>29 - ביטוח רכב מקיף<br/>30 - ביטוח רכב חובה וצד ג'<br/>31 - ביטוח רכב חובה ומקיף<br/>32 - ביטוח תאונות אישיות<br/>33 - ביטוח מוות מתאונה<br/>34 - ביטוח שיניים<br/>35 - ביטוח חיים נכות<br/>36 - ביטוח חיים קולקטיבי<br/>37 - לא ידוע<br/>38 - ביטוח סיעודי קבוצתי<br/>39 - ביטוח חיים ואכ"ע קבוצתי<br/>40 - איחוד קופות<br/>41 - פוליסת חיסכון פיננסי<br/>42 - השקעות אלטרנטיביות<br/>43 - קופת גמל מרכזית לפיצויים<br/>44 - תיק מנוהל<br/>45 - ביטוח אחריות מקצועית<br/>46 - קופת גמל למטרות אחרות

newCompanyIdinteger
newCompanyDisplayNamestring
newProductIdinteger
newProductNamestring
newCompanyContactIdstring uuid
newCompanyContactFullNamestring
newCompanyContactRolestring
newCompanyContactEmail1string
newCompanyContactEmail2string
newCompanyContactPhoneNumber1string
newCompanyContactPhoneNumber2string
newAccountPolicyNumberstring
newCollectiveboolean
newGemel190boolean
newInvestmentTrackIdinteger
newInvestmentTrackDisplayNamestring
newInvestmentTrackPercentnumber
newInvestmentTrackId2integer
newInvestmentTrackDisplayName2string
newInvestmentTrackPercent2number
newInvestmentTrackId3integer
newInvestmentTrackPercent3number
newInvestmentTrackId4integer
newInvestmentTrackPercent4number
newPitsuimInvestmentTrackIdinteger
newPitsuimInvestmentTrackDisplayNamestring
newPitsuimInvestmentTrackPercentnumber
newPitsuimInvestmentTrackId2integer
newPitsuimInvestmentTrackDisplayName2string
newPitsuimInvestmentTrackPercent2number
newPitsuimInvestmentTrackId3integer
newPitsuimInvestmentTrackPercent3number
newPitsuimInvestmentTrackId4integer
newPitsuimInvestmentTrackPercent4number
newInsuranceTrackIdinteger
newInsuranceTrackDisplayNamestring
pensiaVitur11 | 2

Pensia Vitur 1:<br/>1 - בן/בת זוג בלבד<br/>2 - בן/בת זוג וילדים

pensiaVitur21 | 2

Pensia Vitur 2:<br/>1 - וויתור על כיסוי לסיכוני נכות<br/>2 - וויתור על כיסוי למקרה מוות לבן/בת זוג וילדים

policyIssuanceDatestring date
creditCardLastDigitsstring
expectedTransferAccumulationnumber
actualTransferAccumulationnumber
transferAttributionDatestring date
transferRegulatoryDatestring date
transferActualDatestring date
maamad1 | 2 | 3 | 4 | 5 | 6 | 10

Workflow Product Maamad:<br/>1 - שכיר/ה<br/>2 - שכיר/ה בעל/ת שליטה<br/>3 - עצמאי/ת<br/>4 - עצמאי/ת סעיף 47<br/>5 - תיקון 190<br/>6 - שכיר/ה ועצמאי/ת<br/>10 - אחר

paymentMethod1 | 2 | 3 | 4 | 5 | 6

Payment Method:<br/>1 - הוראת קבע<br/>2 - כרטיס אשראי<br/>3 - העברה בנקאית<br/>4 - מסלקה פנסיונית<br/>5 - מס"ב<br/>6 - חברת גביה

employerIdstring uuid
employerIdNumberstring
employerNamestring
employerContactIdstring uuid
employerContactNamestring
employerContactRolestring
employerContactEmail1string
employerContactEmail2string
employerContactPhoneNumber1string
employerContactPhoneNumber2string
depositFeenumber
accumulationFeenumber
formsCustomerSignDatestring date
formsSendDatestring date
shumBituahMavetnumber
shumBituahAkanumber
shumBituahMahalotKashotnumber
shumBituahMavetMiteunanumber
shumBituahNehutMiteunanumber
insurancePricenumber
actualInsurancePricenumber
taarihTashlumPremiaRishonastring date
insurancePremiaDollarnumber
insuranceStartDatestring date
insuranceEndDatestring date
tkufatAhsharaEndDatestring date
franchisaboolean
bitulKizuzboolean
bitulTkufatHahsharaboolean
issukSpetzifiboolean
salarynumber
tagmulimMaasiknumber
tagmulimOvednumber
pitsuimnumber
akaPremiaPercentnumber
akaCoverPercentnumber
meshaabedstring
tosefetRefuitnumber
tosefetIssukitnumber
destinationCountrystring
insuredPersonsCountinteger
memberCardExpiryDatestring date
loanDatestring date
loanPeriodMonthsinteger
loanAmountnumber
loanPaymentType1 | 2

Loan Payment Type:<br/>1 - שפיצר<br/>2 - ריבית שוטפת

loanInterestRatenumber
loanInterestType1 | 2

Loan Interest Type:<br/>1 - קבועה<br/>2 - משתנה

loanIndexLinkType1 | 2 | 3 | 4

Loan Index Link Type:<br/>1 - לא צמוד<br/>2 - צמוד למדד חודשי<br/>3 - צמוד למדד חצי שנתי<br/>4 - אחר

loanPaymentFrequency1 | 2 | 3 | 4 | 5

Loan Payment Frequency:<br/>1 - חודשי<br/>2 - רבעוני<br/>3 - חצי שנתי<br/>4 - שנתי<br/>5 - אחר

pidionExpectedAmountnumber
pidionActualAmountnumber
pidionDatestring date
claimType1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 100 | 200 | 300 | 400 | 500 | 501 | 502 | 503 | 600 | 700 | 800 | 900 | 901 | 902 | 903 | 904 | 1000 | 1001 | 1002

Claim Type:<br/>1 - השתלות בחו"ל<br/>2 - טיפולים מיוחדים בחו"ל<br/>3 - תרופות שלא כלולות בסל הבריאות<br/>4 - ניתוחים פרטיים בארץ<br/>5 - ניתוחים פרטיים באמצעות השב"ן<br/>6 - ניתוחים במימון קופת חולים<br/>7 - ניתוחים בחו"ל<br/>8 - התייעצות עם רופא מומחה<br/>9 - בדיקות רפואיות אבחנתיות<br/>10 - טיפולי פיזיותרפיה<br/>11 - בדיקות הריון<br/>12 - טיפולי הפריה חוץ גופית<br/>13 - טיפולי התפתחות הילד<br/>14 - טיפולים ברפואה משלימה<br/>15 - טיפולים מחליפי ניתוח<br/>16 - ימי אשפוז<br/>17 - אשפוז חירום<br/>18 - אביזרים רפואיים<br/>19 - אבחון מהיר<br/>20 - טיפולים פסיכולוגים<br/>21 - קנאביס רפואי<br/>100 - מחלות קשות<br/>200 - תאונות אישיות<br/>300 - סיעוד<br/>400 - שיניים<br/>500 - פטירה<br/>501 - נכות מתאונה<br/>502 - נכות מקצועית<br/>503 - אובדן כושר עבודה<br/>600 - רכב<br/>700 - דירה<br/>800 - עסק<br/>900 - ביטול נסיעה לחו"ל<br/>901 - קיצור נסיעה לחו"ל<br/>902 - אשפוז במהלך נסיעה לחו"ל<br/>903 - הוצאות רפואיות (ללא אשפוז) בחו"ל<br/>904 - נזק או אובדן למטען<br/>1000 - גמלה<br/>1001 - אובדן כושר עבודה<br/>1002 - שאירים

claimEventDatestring date
claimEventTimestring
claimNumberstring
claimDescriptionstring
claimSupplier1 | 2 | 3 | 4 | 5 | 6 | 7

Claim Supplier:<br/>1 - Bwell<br/>2 - femi<br/>3 - Target Care<br/>4 - ביקור רופא<br/>5 - נטלי<br/>6 - חברת הביטוח<br/>7 - דיאגנוזה

claimDatestring date
claimClosedDatestring date
claimExpectedAmountnumber
claimActualAmountnumber
claimPaymentDatestring date
cancelDatestring date
canceledPremianumber
cancelMean1 | 2

Cancel Mean:<br/>1 - סוכנות<br/>2 - חברת ביטוח

cancelReasonstring
discountsstring
discountsEndDatestring date
tagsstring[]
licenseeIdstring uuid
licenseeNamestring
licenseeCellNumberstring
licenseePhoneNumberstring
licenseeEmailstring
licenseeOperationContactNamestring
licenseeOperationContactPhonestring
licenseeOperationContactEmailstring
agentNumberIdstring uuid
misparSohenstring
misparSohenAv1string
misparSohenAv2string
agentNumberDescriptionstring
supervisorIdstring uuid
supervisorNamestring
businessClassIdstring uuid
businessClassNamestring
notesstring
expectedInitialDepositDatestring date
actualInitialDepositDatestring date
expectedCurrentPremianumber
expectedCurrentPremiaAnnualnumber
actualCurrentPremianumber
expectedOneTimeDepositDatestring date
actualOneTimeDepositDatestring date
expectedOneTimeDepositnumber
actualOneTimeDepositnumber
expectedWithdrawalnumber
actualWithdrawalnumber
unseenboolean
rejectboolean
rejectDatestring date
rejectDescriptionstring
lastActivityDatestring date-time
lastActivityBystring uuid
lastDohYomiTouchDatestring date-time
lastDohYomiSyncDatestring date-time
syncboolean
syncStatusDatestring date-time
sharableboolean
transferrableboolean
appMailAddressstring
controlStatus1 | 2

Control Status:<br/>1 - בקרה תקינה<br/>2 - בקרה נכשלה

controlStatusLastUpdatedAtstring date-time
controlStatusLastUpdatedBystring uuid
retainerServiceNamestring
retainerAmountnumber
retainerFrequency1 | 2 | 3 | 4 | 5

Retainer Frequency:<br/>1 - חד פעמי<br/>2 - חודשי<br/>3 - רבעוני<br/>4 - חצי שנתי<br/>5 - שנתי

retainerPaymentMethod1 | 2 | 3 | 4 | 5

Retainer Payment Method:<br/>1 - כרטיס אשראי<br/>2 - העברה בנקאית<br/>3 - ציק<br/>4 - מזומן<br/>5 - אפליקצית תשלום

retainerNumOfPaymentsinteger
retainerPayerNamestring

Changes

No recorded changes to this operation across all 1 revision of this API.