POST api/v1/ContactCompanies

Creates a ContactCompany

Request Information

URI Parameters

None.

Body Parameters

CreateContactCompanyDto
NameDescriptionTypeAdditional information
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. If there is no parent company use null 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 or null

string

String length: inclusive between 0 and 25

Request Formats

application/json, text/json

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

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Collection of 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-04-24T21:00:55.1291424+00:00"
  },
  {
    "Id": 1,
    "Name": "sample string 2",
    "PrimaryContactId": 1,
    "ContactCompanyId": 1,
    "EmailDomains": "sample string 3",
    "Logo": "sample string 4",
    "Number": "sample string 5",
    "LastModified": "2024-04-24T21:00:55.1291424+00:00"
  }
]