Contacts

Update a contact

patch/contacts/{id}

Request

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

Path parameters

idstring uuid required

Contact ID

Request body

sharedboolean

Whether the contact is shared

companyIdinteger

Company ID

employerIdstring

Employer ID

descriptionstring

Contact description

firstNamestring

First name

lastNamestring

Last name

rolestring

Role/position

phoneNumber1string

Phone number 1

phoneNumber2string

Phone number 2

extensionNumberstring

Extension number

faxNumberstring

Fax number

email1string

Email address 1

email2string

Email address 2

notesstring

Notes

Example request

{
  "companyId": 12345,
  "employerId": "123e4567-e89b-12d3-a456-426614174000",
  "description": "Main contact person",
  "firstName": "John",
  "lastName": "Doe",
  "role": "Manager",
  "phoneNumber1": "972501234567",
  "phoneNumber2": "972507654321",
  "extensionNumber": "123",
  "faxNumber": "+972501234567",
  "email1": "john.doe@example.com",
  "email2": "john.doe2@example.com",
  "notes": "Important contact information"
}

Response

tenantIdstring uuid

agencyIdstring uuid

createdDatestring date-time

createdBystring uuid

creatorNamestring

lastModifiedDatestring date-time

lastModifiedBystring uuid

versioninteger

idstring uuid

sharedboolean

groupIdstring uuid

companyIdinteger

companyNamestring

employerIdstring uuid

employerNamestring