PATCH api/v1/ContactCompanies

Patch ContactCompany by id, only fields in the request are updated

Request Information

URI Parameters

None.

Body Parameters

PatchContactCompanyDto
NameDescriptionTypeAdditional information
Id

ID of the ContactCompany

integer

Required

Name

Company name

string

String length: inclusive between 1 and 255

PrimaryContactId

ID of the primary contact

integer

None.

ContactCompanyId

Id of parent company. Used when the company is a subsidiary or department of another company. If you want to remove a parent company - set the ContactCompanyId to the integer 0 Only 2 levels are allowed (Parent company and subsidiary/department)

integer

None.

EmailDomains

Domains from which the company send emails (as comma separated string)

string

String length: inclusive between 0 and 2000

Logo

URL to the company's logo

string

String length: inclusive between 0 and 500

Number

Your Id for the company (optional) It must be unique

string

String length: inclusive between 0 and 25

Request Formats

application/json, text/json

Sample:
{
  "Id": 1,
  "Name": "sample string 2",
  "PrimaryContactId": 1,
  "ContactCompanyId": 1,
  "EmailDomains": "sample string 3",
  "Logo": "sample string 4",
  "Number": "sample string 5"
}

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ReadContactCompanyDto
NameDescriptionTypeAdditional information
Id

Company id

integer

Required

Name

Company name

string

Required

String length: inclusive between 1 and 255

PrimaryContactId

ID of the primary contact

integer

None.

ContactCompanyId

Id of parent company. Used when the company is a subsidiary or department of another company. Only 2 levels are allowed (Parent company and subsidiary/department)

integer

None.

EmailDomains

Domains from which the company send emails (as comma separated string)

string

Max length: 2000

Logo

URL to the company's logo

string

Max length: 500

Number

Your Id for the company (optional) It must be unique or null

string

Max length: 25

LastModified

When the contact company was last updated

date

Required

Response Formats

application/json, text/json

Sample:
{
  "Id": 1,
  "Name": "sample string 2",
  "PrimaryContactId": 1,
  "ContactCompanyId": 1,
  "EmailDomains": "sample string 3",
  "Logo": "sample string 4",
  "Number": "sample string 5",
  "LastModified": "2024-07-19T06:21:05.3716289+00:00"
}