Customers

Update a customer

patch/customers/{id}

Request

Base URL
https://api.surense.com/api/v1
URL
https://api.surense.com/api/v1/customers/{id}
Auth
OAuth 2
Client credentials
Token URL: https://api.surense.com/oauth/token scopes: customers:update

Path parameters

idstring uuid required

Request body

updateRelatedboolean

Whether to update related customers

idType1 | 2 | 3 | 4 | 5 | 6

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

idNumberstring

ID number

idCardIssueDatestring

ID card issue date

firstNamestring

First name

shortNamestring

Short name

lastNamestring

Last name

maidenNamestring

Maiden name

gender1 | 2 | 3

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

birthDatestring

Birth date

birthDateYearOnlyboolean

Only the birth year is known; birthDate is then stored as Jan 1 of that year

deathboolean

Death status

deathDatestring

Death date

lastMeetingDatestring

Last meeting date

cellNumberstring

Cell phone number

phoneNumberstring

Phone number

phoneNumber2string

Phone number 2

phoneNumber3string

Phone number 3

faxNumberstring

Fax number

emailstring

Email address

otherEmailstring

Other email address

mailingStatus1 | 2 | 3 | 4

Mailing Status: 1 - אושר דיוור 2 - לא אושר דיוור 3 - הוסר מדיוור 4 - לא התבקש אישור

streetstring

Street name

streetNumberstring

Street number

apartmentNumberstring

Apartment number

postalBoxinteger

Postal box number

citystring

City

postalCodeinteger

Postal code

countrystring

Country

maritalStatus1 | 2 | 3 | 4 | 5

Marital Status: 1 - Single 2 - Married 3 - Divorced 4 - Widowed 5 - Cohabiting

employmentStatus1 | 2 | 3 | 4 | 5 | 6 | 7

Employment Status: 1 - שכיר/ה 2 - עצמאי/ת 3 - שכיר/ה ועצמאי/ת 4 - שכיר/ה בעל/ת שליטה 5 - לא מועסק/ת 6 - שכיר/ה בעל/ת שליטה ועצמאי/ת 7 - פנסיונר/ית

professionstring

Profession

usCitizenboolean

US citizen status

foreignTaxResidencyboolean

Foreign tax residency status

engFirstNamestring

English first name

engLastNamestring

English last name

engAddressstring

English address

kupatHolim1 | 2 | 3 | 4 | 5

Kupat Holim: 1 - כללית 2 - מכבי 3 - מאוחדת 4 - לאומית 5 - צה"לית

kupatHolimComplementary10 | 11 | 20 | 21 | 22 | 30 | 31 | 40 | 41

Kupat Holim Complementary: 10 - כללית מושלם זהב 11 - כללית פלטינום 20 - מכבי שלי 21 - מכבי כסף 22 - מכבי זהב 30 - מאוחדת עדיף 31 - מאוחדת שיא 40 - לאומית כסף 41 - לאומית זהב

heightinteger

Height in cm

weightinteger

Weight in kg

smokerboolean

Smoker status

cigarettesCountPerDayinteger

Cigarettes count per day

drugsstring

Drugs information

surgeriesstring

Surgeries information

hospitalizationsstring

Hospitalizations information

backgroundDiseasesstring

Background diseases

bankAccountTypestring

Bank account type

bankCodeinteger

Bank code

bankBranchCodeinteger

Bank branch code

bankAccountNumberstring

Bank account number

classIdstring

Customer class ID

sourceIdstring

Customer source ID

statusIdstring

Customer status ID

notesstring

Notes

notesAlertboolean

Notes alert

monthlyRevenuenumber

Monthly revenue

customerServiceContactDatestring

Customer service contact date

Example request

{
  "updateRelated": true,
  "idType": 1,
  "idNumber": "123456789",
  "idCardIssueDate": "2020-01-15",
  "firstName": "John",
  "shortName": "Johnny",
  "lastName": "Doe",
  "maidenName": "Smith",
  "gender": 2,
  "birthDate": "1990-01-15",
  "deathDate": "2023-12-31",
  "lastMeetingDate": "2023-12-31",
  "cellNumber": "+972501234567",
  "phoneNumber": "+972501234567",
  "phoneNumber2": "+972507654321",
  "phoneNumber3": "+972509876543",
  "faxNumber": "+972501234567",
  "email": "john.doe@example.com",
  "otherEmail": "john.work@example.com",
  "mailingStatus": 1,
  "street": "Main Street",
  "streetNumber": "123",
  "apartmentNumber": "5A",
  "postalBox": 1234,
  "city": "Tel Aviv",
  "postalCode": 12345,
  "country": "Israel",
  "maritalStatus": 2,
  "employmentStatus": 1,
  "profession": "Software Engineer",
  "engFirstName": "John",
  "engLastName": "Doe",
  "engAddress": "123 Main St, Tel Aviv",
  "kupatHolim": 1,
  "kupatHolimComplementary": 10,
  "height": 175,
  "weight": 70,
  "cigarettesCountPerDay": 10,
  "drugs": "None",
  "surgeries": "None",
  "hospitalizations": "None",
  "backgroundDiseases": "None",
  "bankAccountType": "CHECKING",
  "bankCode": 10,
  "bankBranchCode": 123,
  "bankAccountNumber": "123456789",
  "classId": "123e4567-e89b-12d3-a456-426614174000",
  "sourceId": "123e4567-e89b-12d3-a456-426614174000",
  "statusId": "123e4567-e89b-12d3-a456-426614174000",
  "notes": "Important customer notes",
  "notesAlert": true,
  "monthlyRevenue": 5000,
  "customerServiceContactDate": "2024-01-15T10:00:00Z"
}

Response

tenantIdstring uuid

agencyIdstring uuid

createdDatestring date-time

createdBystring uuid

creatorNamestring

lastModifiedDatestring date-time

lastModifiedBystring uuid

versioninteger

idstring uuid

duplicateboolean

statusIdstring uuid

statusNamestring

statusActiveboolean

sourceIdstring uuid

sourceNamestring

customerClassIdstring uuid

classIdstring uuid

classNamestring

managerIdstring uuid

managersstring[]

sensitiveboolean

mailingStatus1 | 2 | 3 | 4

Mailing Status: 1 - אושר דיוור 2 - לא אושר דיוור 3 - הוסר מדיוור 4 - לא התבקש אישור

mailingStatusDatestring date-time

idType1 | 2 | 3 | 4 | 5 | 6

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

idNumberstring

idNumberLockedboolean

idCardIssueDatestring date

firstNamestring

shortNamestring

lastNamestring

fullNamestring

fullNameReversestring

maidenNamestring

engFirstNamestring

engLastNamestring

cellNumberstring

cellNumberVerifiedboolean

cellNumberFormattedstring

cellNumberUristring

cellNumberWhatsAppUristring

phoneNumberstring

phoneNumberFormattedstring

phoneNumberUristring

phoneNumberWhatsAppUristring

phoneNumber2string

phoneNumber2Formattedstring

phoneNumber2Uristring

phoneNumber2WhatsAppUristring

phoneNumber3string

phoneNumber3Formattedstring

phoneNumber3Uristring

phoneNumber3WhatsAppUristring

faxNumberstring

faxNumberFormattedstring

faxNumberUristring

emailstring

emailBounceboolean

emailComplaintboolean

otherEmailstring

gender1 | 2 | 3

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

birthDatestring date

birthDayinteger

birthMonthinteger

birthYearinteger

birthDateYearOnlyboolean

agestring

minorboolean

deathboolean

deathDatestring date

streetstring

streetNumberstring

apartmentNumberstring

postalBoxinteger

citystring

postalCodeinteger

countrystring

addressstring

maritalStatus1 | 2 | 3 | 4 | 5

Marital Status: 1 - רווק/ה 2 - נשוי/אה 3 - גרוש/ה 4 - אלמן/ה 5 - ידוע/ה בציבור

childrenCountinteger

partnerIdstring uuid

partnerNamestring

professionstring

employmentStatus1 | 2 | 3 | 4 | 5 | 6 | 7

employerId1string uuid

employerName1string

employmentIncome1integer

employerId2string uuid

employerName2string

employmentIncome2integer

usCitizenboolean

foreignTaxResidencyboolean

engAddressstring

kupatHolim1 | 2 | 3 | 4 | 5

Kupat Holim: 1 - כללית 2 - מכבי 3 - מאוחדת 4 - לאומית 5 - צה"לית

kupatHolimComplementary10 | 11 | 20 | 21 | 22 | 30 | 31 | 40 | 41

heightinteger

weightinteger

smokerboolean

cigarettesCountPerDayinteger

drugsstring

surgeriesstring

hospitalizationsstring

backgroundDiseasesstring

bankAccountTypestring

bankCodeinteger

bankBranchCodeinteger

bankAccountNumberstring

swiftnessProxyInviteDatestring date

swiftnessProxySignDatestring date

swiftnessProxyExpiryDatestring date

swiftnessProxyExpiredboolean

lastE9100DataDatestring date

outdatedE9100Databoolean

swiftnessDataboolean

hbProxyInviteDatestring date

hbProxySignDatestring date

hbProxyExpiryDatestring date

hbProxyExpiredboolean

hbDataDatestring date

policiesProxyInviteDatestring date

policiesProxySignDatestring date

policiesProxyExpiryDatestring date

policiesProxyExpiredboolean

lastSwiftnessProductiaMonthstring

lastPratProductiaMonthstring

lastProductiaMonthstring

notesstring

notesUpdatedBystring uuid

notesUpdatedAtstring date-time

notesAlertboolean

reportEnabledboolean

reportPeriod'חד_פעמי' | 'חודשי' | 'רבעוני' | 'חצי_שנתי' | 'שנתי'

reportFormat'ממשק_אינטרנטי' | 'PDF'

reportByEmailboolean

reportByCellNumberboolean

reportIncludesInvestmentProductsboolean

reportIncludesInsuranceProductsboolean

reportDetailType1 | 2 | 3

reportFamilyboolean

reportFamilyDatestring date-time

reportFamilyExpiryDatestring date-time

reportFamilyExpiredboolean

lastSentConsultingReportIdstring uuid

lastSentConsultingReportTimestampstring date-time

lastSentProductiaReportIdstring uuid

lastSentProductiaReportTimestampstring date-time

lastProductiaReportAccessDatestring date-time

lastActivityDatestring date-time

lastActivityBystring uuid

lastMeetingDatestring date

monthlyRevenuenumber

appMailAddressstring

customerServiceEnabledboolean

customerServiceRecurrence1 | 2 | 3 | 4

customerServiceSmsboolean

customerServiceEmailboolean

tagsstring[]

surenseOneActiveboolean

Changes

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