OPTIONS api/Contact/{id}
No documentation available.
Request Information
Parameters
| Name | Description | Additional information |
|---|---|---|
| id | No documentation available. |
Define this parameter in the request URI. |
| organisation | No documentation available. |
Define this parameter in the request body. |
Request body formats
application/json, text/json
Sample:
{
"Name": "sample string 1",
"Business": {
"$id": "2",
"Id": "2e47be90-2f54-48e8-a557-b0dea31cb7f8",
"Description": "sample string 2",
"StartDate": "2025-11-05T21:51:50.1741192+00:00",
"FirstOwner": "sample string 3",
"AnnualTurnOver": "sample string 4",
"GroupClassification": "sample string 5",
"Division": "sample string 6",
"NoOfPeople": 7,
"Contact": {
"$ref": "1"
}
},
"Individual": {
"$id": "3",
"$values": [
{
"$id": "4",
"Title": "sample string 1",
"FirstName": "sample string 2",
"LastName": "sample string 3",
"Postition": "sample string 4",
"Organisation": {
"$id": "5",
"$values": [
{
"$ref": "1"
},
{
"$ref": "1"
},
{
"$ref": "1"
}
]
},
"IsCompanyBased": true,
"SaveId": "d1979831-6e4d-4b4e-a8ec-7993755ecc28",
"TenantId": "sample string 8",
"EdgeTenantId": "sample string 9",
"EdgeCompanyName": "sample string 10",
"ContactSignature": "sample string 11",
"UserId": "sample string 12",
"ContactSource": "sample string 13",
"UserName": "sample string 14",
"Status": "sample string 15",
"PreferredTradeCurrency": "sample string 16",
"MaxCreditLimit": 17.1,
"CreditCurrency": "sample string 18",
"DueTimeTill": 19,
"KnownSince": "2025-11-05T21:51:50.1741192+00:00",
"LastActivity": "2025-11-05T21:51:50.1741192+00:00",
"XeroShortCode": "sample string 20",
"Image": "sample string 21",
"Categories": "sample string 22",
"CreditRating": "sample string 23",
"Grade": "sample string 24",
"Phone": {
"$id": "6",
"$values": [
{
"$id": "7",
"Id": 1,
"PhoneNo": "sample string 2",
"PhoneExt": "sample string 3",
"PhoneType": "sample string 4",
"ContactId": "9cb701d1-01eb-4149-af7b-6e4ae1c0fcc7",
"Contact": {
"$id": "8",
"SaveId": "50b23f3a-fdc1-4be8-b1bc-ef7367fb2d8b",
"TenantId": "sample string 2",
"EdgeTenantId": "sample string 3",
"EdgeCompanyName": "sample string 4",
"ContactSignature": "sample string 5",
"UserId": "sample string 6",
"ContactSource": "sample string 7",
"UserName": "sample string 8",
"Status": "sample string 9",
"PreferredTradeCurrency": "sample string 10",
"MaxCreditLimit": 11.1,
"CreditCurrency": "sample string 12",
"DueTimeTill": 13,
"KnownSince": "2025-11-05T21:51:50.1897489+00:00",
"LastActivity": "2025-11-05T21:51:50.1897489+00:00",
"XeroShortCode": "sample string 14",
"Image": "sample string 15",
"Categories": "sample string 16",
"CreditRating": "sample string 17",
"Grade": "sample string 18",
"Phone": {
"$id": "9",
"$values": [
{
"$ref": "7"
},
{
"$ref": "7"
},
{
"$ref": "7"
}
]
},
"SocialChannel": {
"$id": "10",
"$values": [
{
"$id": "11",
"Id": 1,
"ContactChannel": "sample string 2",
"ChannelType": "sample string 3",
"ContactId": "cfaece83-cb23-45dc-bf09-106556a96379",
"Contact": {
"$ref": "8"
},
"IsDeleted": true
},
{
"$ref": "11"
},
{
"$ref": "11"
}
]
},
"Website": {
"$id": "12",
"$values": [
{
"$id": "13",
"Id": 1,
"WebName": "sample string 2",
"WebType": "sample string 3",
"ContactId": "d508ee42-8525-474a-8a5f-d8257f85adb3",
"IsDeleted": true,
"Contact": {
"$ref": "8"
}
},
{
"$ref": "13"
},
{
"$ref": "13"
}
]
},
"Email": {
"$id": "14",
"$values": [
{
"$id": "15",
"Id": 1,
"ContactEmail": "sample string 2",
"EmailType": "sample string 3",
"ContactId": "3d94c793-4934-41ee-b98c-203d548c722c",
"Contact": {
"$ref": "8"
},
"IsDeleted": true
},
{
"$ref": "15"
},
{
"$ref": "15"
}
]
},
"Note": {
"$id": "16",
"$values": [
{
"$id": "17",
"Id": 1,
"UserId": "sample string 2",
"Activity": "sample string 3",
"Detail": "sample string 4",
"CreatdTimestamp": "2025-11-05T21:51:50.1897489+00:00",
"UserName": "sample string 6",
"Message": "sample string 7",
"ContactId": "86427b69-3d5d-41a2-975c-bbcdcf5bf958",
"Contact": {
"$ref": "8"
}
},
{
"$ref": "17"
},
{
"$ref": "17"
}
]
},
"Address": {
"$id": "18",
"$values": [
{
"$id": "19",
"AddressId": 1,
"CountryName": "sample string 2",
"AddressType": "sample string 3",
"AddressLine1": "sample string 4",
"AddressLine2": "sample string 5",
"TownLocality": "sample string 6",
"CityRegion": "sample string 7",
"PostalZipCode": "sample string 8",
"State": "sample string 9",
"INState": "sample string 10",
"MXState": "sample string 11",
"BRState": "sample string 12",
"CAState": "sample string 13",
"SiteName": "sample string 14",
"IsMain": true,
"ContactId": "e8809988-10b2-4829-bba6-1fd89fa04f8e",
"Contact": {
"$ref": "8"
},
"IsDeleted": true
},
{
"$ref": "19"
},
{
"$ref": "19"
}
]
},
"Carrier": {
"$id": "20",
"$values": [
{
"$id": "21",
"CarrierId": 1,
"LogisticCompany": "sample string 2",
"AccountNumber": "sample string 3",
"TaxNumber": "sample string 4",
"TaxType": "sample string 5",
"IsMain": true,
"ContactId": "666e1607-d289-4877-bc15-db4758efb125",
"Contact": {
"$ref": "8"
},
"IsDeleted": true
},
{
"$ref": "21"
},
{
"$ref": "21"
}
]
},
"BankDetail": {
"$id": "22",
"AccountId": "4cde37ad-4ab0-471d-a9d0-eb70b03cbc62",
"AccountName": "sample string 2",
"AccountNo": "sample string 3",
"SortCode": "sample string 4",
"BankIBAN": "sample string 5",
"BankSwift": "sample string 6",
"Contact": {
"$ref": "8"
}
},
"ControlsLicence": {
"$id": "23",
"ControlsLicenceId": "a42ef573-bf9e-46bd-9d13-abd35e9e80fb",
"IsLicence": true,
"LicenceNo": "sample string 3",
"LicenceExpiryDate": "sample string 4",
"Contact": {
"$ref": "8"
},
"IsDeleted": true
},
"FinancialArrangement": {
"$id": "24",
"FinancialId": "e03d0a36-b9e9-4fcf-aec4-9552fbc7ee9a",
"PaymentTerm": "sample string 2",
"PaymentTermValue": "sample string 3",
"PaymentMethod": "sample string 4",
"PaymentMethodValue": "sample string 5",
"Discount": 6.1,
"Commission": 7.1,
"BankAccountName": "sample string 8",
"BankAccountNumber": "sample string 9",
"BankSortCode": "sample string 10",
"SaleTaxRegistration": "sample string 11",
"SaleTax": "sample string 12",
"CompanyRegistrationNumber": "sample string 13",
"CustomerAccNo": "sample string 14",
"EoriNumber": "sample string 15",
"Contact": {
"$ref": "8"
}
},
"Supplier": {
"$id": "25",
"Id": "989bc0b5-6df0-4c54-8ebe-0f6a193c0775",
"AccountNo": "sample string 2",
"SupplierId": "sample string 3",
"NormalLeadTime": 4.0,
"ActualLeadTime": 5.0,
"OrderQuantity": 6.0,
"OrderValue": 7.0,
"CallOff": 8.0,
"IsSupplier": true,
"Contact": {
"$ref": "8"
}
},
"Logistic": {
"$id": "26",
"Id": "b50d31f3-cc7c-4af7-ba7a-b0fd39864e31",
"EmailForQuote": "sample string 2",
"IsLogisticQuote": true,
"IsLogisticFirm": true,
"Contact": {
"$ref": "8"
}
},
"Category": {
"$id": "27",
"CategoryId": "b2eb4594-e237-4637-b273-0d76c0779730",
"IsAgent": true,
"IsConsultant": true,
"IsCustomer": true,
"IsDistributor": true,
"IsFinancer": true,
"IsFreightForwarder": true,
"IsInsurer": true,
"IsReferrer": true,
"IsManufacturer": true,
"IsFriend": true,
"IsProcessor": true,
"IsStaff": true,
"IsOther": true,
"IsConsignor": true,
"IsSupplier": true,
"IsInstaller": true,
"IsDriver": true,
"IsSubContractor": true,
"Miscellaneous": "sample string 20",
"IsRetailer": true,
"IsSeller": true,
"Contact": {
"$ref": "8"
}
},
"ContactFiles": {
"$id": "28",
"$values": [
{
"$id": "29",
"ContactFileId": "b3909692-1f0f-43f3-bf0e-dac0e8c6b4f4",
"ContactSaveId": "c8248aa5-0da9-4156-9be0-8f46ed68dcf9",
"SpecificationType": "sample string 3",
"FileName": "sample string 4",
"DocType": "sample string 5",
"WhenAttached": "sample string 6",
"ValidTillDateTime": "sample string 7",
"NoOfPages": "sample string 8",
"FileData": "sample string 9",
"FilePath": "sample string 10",
"Comments": "sample string 11",
"Contact": {
"$ref": "8"
}
},
{
"$ref": "29"
},
{
"$ref": "29"
}
]
},
"ContactMethod": {
"$id": "30",
"ContactMethodId": "bebfaad5-c159-43cf-80ef-9a7c20f60aa8",
"LinkedIn": "sample string 2",
"Twitter": "sample string 3",
"FaceBook": "sample string 4",
"IM": {
"$id": "31",
"$values": [
{
"$id": "32",
"Id": 1,
"Message": "sample string 2",
"IMType": "sample string 3",
"ContactMethodId": "c1bcc164-e88f-4fa6-98c7-a084862ea518",
"ContactMethod": {
"$ref": "30"
},
"IsDeleted": true
},
{
"$ref": "32"
},
{
"$ref": "32"
}
]
},
"Contact": {
"$ref": "8"
}
},
"BuyingCriteria": {
"$id": "33",
"CriteriaId": "a27f5cbe-e859-44f6-9563-6d8688b8ead8",
"AuthoriseToBuy": "sample string 2",
"Period": "sample string 3",
"Method": "sample string 4",
"Power": "sample string 5",
"Expectation": "sample string 6",
"Need": "sample string 7",
"Contact": {
"$ref": "8"
}
},
"SaleApproach": {
"$id": "34",
"Id": "076be4de-548b-4584-9ad4-6a2403e75a8a",
"GiveDiscounts": "sample string 2",
"ContactEvery": "sample string 3",
"EmailMarketing": "sample string 4",
"CurrentSupplier": "sample string 5",
"Competitor": "sample string 6",
"Competitors": {
"$id": "35",
"$values": [
{
"$id": "36",
"Id": 1,
"CompetitorName": "sample string 2",
"SaleId": "6be6d4a9-732a-4266-b0b3-1eeeeafa2fd2",
"SaleApproach": {
"$ref": "34"
},
"IsDeleted": true
},
{
"$ref": "36"
},
{
"$ref": "36"
}
]
},
"Suppliers": {
"$id": "37",
"$values": [
{
"$id": "38",
"Id": 1,
"SupplierName": "sample string 2",
"SaleId": "7898f31c-f81f-4906-8b20-282d31071b33",
"SaleApproach": {
"$ref": "34"
},
"IsDeleted": true
},
{
"$ref": "38"
},
{
"$ref": "38"
}
]
},
"OurRelationship": "sample string 7",
"RelationshipMgr": "sample string 8",
"Contact": {
"$ref": "8"
}
},
"AppendNotes": {
"$id": "39",
"$values": [
{
"$id": "40",
"AppendNoteId": 1,
"CreatedDate": "2025-11-05T21:51:50.1897489+00:00",
"CreatedBy": "sample string 3",
"ActivityNote": "sample string 4",
"AppendNote": "sample string 5",
"Subject": "sample string 6",
"ContactName": "sample string 7",
"ContactMethod": "sample string 8",
"Location": "sample string 9",
"ChildAppendNotes": "sample string 10",
"ContactId": "3d213dea-d947-42d3-bed1-3fa63809aabd",
"Contact": {
"$ref": "8"
}
},
{
"$ref": "40"
},
{
"$ref": "40"
}
]
},
"Event": {
"$id": "41",
"$values": [
{
"$id": "42",
"EventId": 1,
"Subject": "sample string 2",
"EventType": "sample string 3",
"AssignTo": "sample string 4",
"StartDate": "2025-11-05T21:51:50.1897489+00:00",
"EndDate": "2025-11-05T21:51:50.1897489+00:00",
"IsAllDayEvent": "sample string 7",
"ContactName": "sample string 8",
"ContactEmail": "sample string 9",
"ContactMethod": "sample string 10",
"Location": "sample string 11",
"Status": "sample string 12",
"IsCalendarEvent": "sample string 13",
"Note": "sample string 14",
"SenderComapny": "sample string 15",
"SenderEmail": "sample string 16",
"MainEventId": 17,
"ContactId": "22190e82-bebb-481c-8355-cf02bb8c9217",
"Contact": {
"$ref": "8"
}
},
{
"$ref": "42"
},
{
"$ref": "42"
}
]
},
"CreatedTimestamp": "2025-11-05T21:51:50.1897489+00:00",
"IsClient": true,
"RpsStatus": "sample string 21",
"RpsUpdatedDate": "2025-11-05T21:51:50.1897489+00:00",
"PersonalInformation": {
"$id": "43",
"PersonalId": "9bdafe40-3b81-4fe9-908e-5ea9a5e3a2f9",
"Gender": "sample string 1",
"DateOfBirth": "2025-11-05T21:51:50.1897489+00:00",
"NotifyBirthday": "sample string 2",
"Occupation": "sample string 3",
"MaritalStatus": "sample string 4",
"PersonalStatus": "sample string 5",
"Interests": "sample string 6",
"NationalInsuranceNo": "sample string 7",
"Contact": {
"$ref": "8"
}
},
"MinExpiryDays": 22,
"CountryList": {
"$id": "44",
"$values": [
{
"$id": "45",
"Id": 1,
"CountryCode": "sample string 2",
"Name": "sample string 3",
"Type": "sample string 4"
},
{
"$ref": "45"
},
{
"$ref": "45"
}
]
},
"XeroId": "89c8528f-6dfd-4573-bb96-7df2607ce231",
"OwingAmount": 24.1,
"OwingCcy": "sample string 25",
"FreeAgentId": "sample string 26",
"QuickBookId": "sample string 27",
"QuickBookSupplierId": "sample string 28",
"SageOneId": "sample string 29",
"ShopifyId": "sample string 30",
"BigCommerceId": "sample string 31",
"FaireId": "sample string 32",
"WooCommerceId": "sample string 33",
"UpdatedDateTimeStamp": "2025-11-05T21:51:50.1897489+00:00",
"OrganisationId": "sample string 35",
"Main": true,
"WBSBookingId": "005eda8a-f4d8-49a8-a092-313b49947ef4",
"WBSFirmSaveId": "d6ae7ddf-c9eb-4d27-9b1b-936db0e5be79",
"WBSDriverSaveId": "a3bdbee6-0af2-4319-a02a-4d622945e703",
"WBSUserId": "46a80914-1b3b-4542-bd47-3639102b5000",
"WBSUserSaveId": "46c33347-27c3-4831-a0c5-47627007c19b"
},
"IsDeleted": true
},
{
"$ref": "7"
},
{
"$ref": "7"
}
]
},
"SocialChannel": {
"$id": "46",
"$values": [
{
"$ref": "11"
},
{
"$ref": "11"
},
{
"$ref": "11"
}
]
},
"Website": {
"$id": "47",
"$values": [
{
"$ref": "13"
},
{
"$ref": "13"
},
{
"$ref": "13"
}
]
},
"Email": {
"$id": "48",
"$values": [
{
"$ref": "15"
},
{
"$ref": "15"
},
{
"$ref": "15"
}
]
},
"Note": {
"$id": "49",
"$values": [
{
"$ref": "17"
},
{
"$ref": "17"
},
{
"$ref": "17"
}
]
},
"Address": {
"$id": "50",
"$values": [
{
"$ref": "19"
},
{
"$ref": "19"
},
{
"$ref": "19"
}
]
},
"Carrier": {
"$id": "51",
"$values": [
{
"$ref": "21"
},
{
"$ref": "21"
},
{
"$ref": "21"
}
]
},
"BankDetail": {
"$ref": "22"
},
"ControlsLicence": {
"$ref": "23"
},
"FinancialArrangement": {
"$ref": "24"
},
"Supplier": {
"$ref": "25"
},
"Logistic": {
"$ref": "26"
},
"Category": {
"$ref": "27"
},
"ContactFiles": {
"$id": "52",
"$values": [
{
"$ref": "29"
},
{
"$ref": "29"
},
{
"$ref": "29"
}
]
},
"ContactMethod": {
"$ref": "30"
},
"BuyingCriteria": {
"$ref": "33"
},
"SaleApproach": {
"$ref": "34"
},
"AppendNotes": {
"$id": "53",
"$values": [
{
"$ref": "40"
},
{
"$ref": "40"
},
{
"$ref": "40"
}
]
},
"Event": {
"$id": "54",
"$values": [
{
"$ref": "42"
},
{
"$ref": "42"
},
{
"$ref": "42"
}
]
},
"CreatedTimestamp": "2025-11-05T21:51:50.1897489+00:00",
"IsClient": true,
"RpsStatus": "sample string 27",
"RpsUpdatedDate": "2025-11-05T21:51:50.1897489+00:00",
"PersonalInformation": {
"$ref": "43"
},
"MinExpiryDays": 28,
"CountryList": {
"$id": "55",
"$values": [
{
"$ref": "45"
},
{
"$ref": "45"
},
{
"$ref": "45"
}
]
},
"XeroId": "f1a6c2b9-d222-4e8c-acd9-236d8b08bbb1",
"OwingAmount": 30.1,
"OwingCcy": "sample string 31",
"FreeAgentId": "sample string 32",
"QuickBookId": "sample string 33",
"QuickBookSupplierId": "sample string 34",
"SageOneId": "sample string 35",
"ShopifyId": "sample string 36",
"BigCommerceId": "sample string 37",
"FaireId": "sample string 38",
"WooCommerceId": "sample string 39",
"UpdatedDateTimeStamp": "2025-11-05T21:51:50.1897489+00:00",
"OrganisationId": "sample string 41",
"Main": true,
"WBSBookingId": "eadfbf6b-124e-47fc-bbfd-62b64b479343",
"WBSFirmSaveId": "fbf8d04c-813d-43f7-98c9-f6a4b4868b5e",
"WBSDriverSaveId": "20e3a9f7-c21d-44ed-b676-7f44579c940c",
"WBSUserId": "e0c78481-96a0-4b2b-8b58-a0cbfcaf77b8",
"WBSUserSaveId": "8f92a1d9-bf55-49a1-a286-6c330bb6e6dd"
},
{
"$ref": "4"
},
{
"$ref": "4"
}
]
},
"SaveId": "51e2f381-4ea4-4975-be6a-98b5a6a68c3e",
"TenantId": "sample string 3",
"EdgeTenantId": "sample string 4",
"EdgeCompanyName": "sample string 5",
"ContactSignature": "sample string 6",
"UserId": "sample string 7",
"ContactSource": "sample string 8",
"UserName": "sample string 9",
"Status": "sample string 10",
"PreferredTradeCurrency": "sample string 11",
"MaxCreditLimit": 12.1,
"CreditCurrency": "sample string 13",
"DueTimeTill": 14,
"KnownSince": "2025-11-05T21:51:50.1897489+00:00",
"LastActivity": "2025-11-05T21:51:50.1897489+00:00",
"XeroShortCode": "sample string 15",
"Image": "sample string 16",
"Categories": "sample string 17",
"CreditRating": "sample string 18",
"Grade": "sample string 19",
"Phone": {
"$id": "56",
"$values": [
{
"$ref": "7"
},
{
"$ref": "7"
},
{
"$ref": "7"
}
]
},
"SocialChannel": {
"$id": "57",
"$values": [
{
"$ref": "11"
},
{
"$ref": "11"
},
{
"$ref": "11"
}
]
},
"Website": {
"$id": "58",
"$values": [
{
"$ref": "13"
},
{
"$ref": "13"
},
{
"$ref": "13"
}
]
},
"Email": {
"$id": "59",
"$values": [
{
"$ref": "15"
},
{
"$ref": "15"
},
{
"$ref": "15"
}
]
},
"Note": {
"$id": "60",
"$values": [
{
"$ref": "17"
},
{
"$ref": "17"
},
{
"$ref": "17"
}
]
},
"Address": {
"$id": "61",
"$values": [
{
"$ref": "19"
},
{
"$ref": "19"
},
{
"$ref": "19"
}
]
},
"Carrier": {
"$id": "62",
"$values": [
{
"$ref": "21"
},
{
"$ref": "21"
},
{
"$ref": "21"
}
]
},
"BankDetail": {
"$ref": "22"
},
"ControlsLicence": {
"$ref": "23"
},
"FinancialArrangement": {
"$ref": "24"
},
"Supplier": {
"$ref": "25"
},
"Logistic": {
"$ref": "26"
},
"Category": {
"$ref": "27"
},
"ContactFiles": {
"$id": "63",
"$values": [
{
"$ref": "29"
},
{
"$ref": "29"
},
{
"$ref": "29"
}
]
},
"ContactMethod": {
"$ref": "30"
},
"BuyingCriteria": {
"$ref": "33"
},
"SaleApproach": {
"$ref": "34"
},
"AppendNotes": {
"$id": "64",
"$values": [
{
"$ref": "40"
},
{
"$ref": "40"
},
{
"$ref": "40"
}
]
},
"Event": {
"$id": "65",
"$values": [
{
"$ref": "42"
},
{
"$ref": "42"
},
{
"$ref": "42"
}
]
},
"CreatedTimestamp": "2025-11-05T21:51:50.1897489+00:00",
"IsClient": true,
"RpsStatus": "sample string 22",
"RpsUpdatedDate": "2025-11-05T21:51:50.1897489+00:00",
"PersonalInformation": {
"$ref": "43"
},
"MinExpiryDays": 23,
"CountryList": {
"$id": "66",
"$values": [
{
"$ref": "45"
},
{
"$ref": "45"
},
{
"$ref": "45"
}
]
},
"XeroId": "8407fe47-7fed-48c6-95ff-bd691698a801",
"OwingAmount": 25.1,
"OwingCcy": "sample string 26",
"FreeAgentId": "sample string 27",
"QuickBookId": "sample string 28",
"QuickBookSupplierId": "sample string 29",
"SageOneId": "sample string 30",
"ShopifyId": "sample string 31",
"BigCommerceId": "sample string 32",
"FaireId": "sample string 33",
"WooCommerceId": "sample string 34",
"UpdatedDateTimeStamp": "2025-11-05T21:51:50.1897489+00:00",
"OrganisationId": "sample string 36",
"Main": true,
"WBSBookingId": "d0ada131-fd3e-4eec-9253-d0a814647260",
"WBSFirmSaveId": "372346dd-4876-4373-8cf1-306a20229de6",
"WBSDriverSaveId": "b93bf911-45c8-48bb-893f-85250c7daf87",
"WBSUserId": "83cd36e6-c7d7-4b27-895b-5126d7ddbecc",
"WBSUserSaveId": "38c0ff08-02a1-4763-818f-1c4019762036"
}
application/xml
Sample:
text/xml
Sample:
application/x-www-form-urlencoded
Sample:
Response Information
No documentation available.
Response body formats
application/json, text/json, application/xml, text/xml
Sample:
Sample not available.