SUsurense
Employers

Update an employer

Update an employer.

patch/employers/{id}

Request

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

Path parameters

idstring uuid required

Employer ID

Request body

idTypestring

Employer identity type

idNumberstring

ID number

namestring

Employer name

streetstring

Street address

streetNumberstring

Street number

apartmentNumberstring

Apartment number

postalBoxinteger

Postal box number

citystring

City

countrystring

Country

postalCodeinteger

Postal code

misparTikNikuimstring

Mispar Tik Nikuim

notesstring

Notes

notesAlertboolean

Notes alert

managerIdstring

Manager ID

Example request

{
  "idType": "COMPANY",
  "idNumber": "123456789",
  "name": "ABC Company Ltd",
  "street": "Main Street",
  "streetNumber": "123",
  "apartmentNumber": "4A",
  "postalBox": 123,
  "city": "Tel Aviv",
  "country": "Israel",
  "postalCode": 12345,
  "misparTikNikuim": "123456",
  "notes": "Additional notes",
  "notesAlert": true,
  "managerId": "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
idType'עוסק_מורשה' | 'חברה_פרטית' | 'חברה_ציבורית' | 'עמותה_רשומה' | 'אגודה_שיתופית' | 'שותפות' | 'אחר'
idNumberstring
namestring
streetstring
streetNumberstring
apartmentNumberstring
postalBoxinteger
citystring
countrystring
postalCodeinteger
notesstring
notesUpdatedBystring uuid
notesUpdatedAtstring date-time
notesAlertboolean
misparTikNikuimstring
managerIdstring uuid
managerNamestring
tagsstring[]
lastActivityDatestring date-time
lastActivityBystring uuid
appMailAddressstring

Changes

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