POST api/Event

No documentation available.

Request Information

Parameters

NameDescriptionAdditional information
value
No documentation available.

Define this parameter in the request body.

Request body formats

application/json, text/json

Sample:
{
  "EventId": 1,
  "Subject": "sample string 2",
  "EventType": "sample string 3",
  "AssignTo": "sample string 4",
  "StartDate": "2026-02-04T02:39:46.8712266+00:00",
  "EndDate": "2026-02-04T02:39:46.8712266+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": "b9051e7c-3efd-485b-8b31-b6e20cc88e1f",
  "Contact": {
    "$id": "2",
    "SaveId": "7cd13ccd-509e-4528-a943-4573a4c0c13f",
    "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": "2026-02-04T02:39:47.5433167+00:00",
    "LastActivity": "2026-02-04T02:39:47.5433167+00:00",
    "XeroShortCode": "sample string 14",
    "Image": "sample string 15",
    "Categories": "sample string 16",
    "CreditRating": "sample string 17",
    "Grade": "sample string 18",
    "Phone": {
      "$id": "3",
      "$values": [
        {
          "$id": "4",
          "Id": 1,
          "PhoneNo": "sample string 2",
          "PhoneExt": "sample string 3",
          "PhoneType": "sample string 4",
          "ContactId": "a12f1024-11ec-4e5f-81ce-3363348bedba",
          "Contact": {
            "$ref": "2"
          },
          "IsDeleted": true
        },
        {
          "$ref": "4"
        },
        {
          "$ref": "4"
        }
      ]
    },
    "SocialChannel": {
      "$id": "5",
      "$values": [
        {
          "$id": "6",
          "Id": 1,
          "ContactChannel": "sample string 2",
          "ChannelType": "sample string 3",
          "ContactId": "bbe627fc-193b-4270-a8c3-21263f2061ac",
          "Contact": {
            "$ref": "2"
          },
          "IsDeleted": true
        },
        {
          "$ref": "6"
        },
        {
          "$ref": "6"
        }
      ]
    },
    "Website": {
      "$id": "7",
      "$values": [
        {
          "$id": "8",
          "Id": 1,
          "WebName": "sample string 2",
          "WebType": "sample string 3",
          "ContactId": "e86c4c31-efba-4091-a912-c8e4531061a2",
          "IsDeleted": true,
          "Contact": {
            "$ref": "2"
          }
        },
        {
          "$ref": "8"
        },
        {
          "$ref": "8"
        }
      ]
    },
    "Email": {
      "$id": "9",
      "$values": [
        {
          "$id": "10",
          "Id": 1,
          "ContactEmail": "sample string 2",
          "EmailType": "sample string 3",
          "ContactId": "69c03484-f275-4d7c-b391-ce0b925fa5ee",
          "Contact": {
            "$ref": "2"
          },
          "IsDeleted": true
        },
        {
          "$ref": "10"
        },
        {
          "$ref": "10"
        }
      ]
    },
    "Note": {
      "$id": "11",
      "$values": [
        {
          "$id": "12",
          "Id": 1,
          "UserId": "sample string 2",
          "Activity": "sample string 3",
          "Detail": "sample string 4",
          "CreatdTimestamp": "2026-02-04T02:39:47.5433167+00:00",
          "UserName": "sample string 6",
          "Message": "sample string 7",
          "ContactId": "409cb8cc-35b1-4176-91e1-0070ec90fee2",
          "Contact": {
            "$ref": "2"
          }
        },
        {
          "$ref": "12"
        },
        {
          "$ref": "12"
        }
      ]
    },
    "Address": {
      "$id": "13",
      "$values": [
        {
          "$id": "14",
          "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": "000f91c0-3a96-4432-a23d-cc4df8c20e8c",
          "Contact": {
            "$ref": "2"
          },
          "IsDeleted": true
        },
        {
          "$ref": "14"
        },
        {
          "$ref": "14"
        }
      ]
    },
    "Carrier": {
      "$id": "15",
      "$values": [
        {
          "$id": "16",
          "CarrierId": 1,
          "LogisticCompany": "sample string 2",
          "AccountNumber": "sample string 3",
          "TaxNumber": "sample string 4",
          "TaxType": "sample string 5",
          "IsMain": true,
          "ContactId": "596954e8-cd42-483a-b431-4b93e1bdbf15",
          "Contact": {
            "$ref": "2"
          },
          "IsDeleted": true
        },
        {
          "$ref": "16"
        },
        {
          "$ref": "16"
        }
      ]
    },
    "BankDetail": {
      "$id": "17",
      "AccountId": "a8709279-eeec-4709-b56f-5f686ab8a427",
      "AccountName": "sample string 2",
      "AccountNo": "sample string 3",
      "SortCode": "sample string 4",
      "BankIBAN": "sample string 5",
      "BankSwift": "sample string 6",
      "Contact": {
        "$ref": "2"
      }
    },
    "ControlsLicence": {
      "$id": "18",
      "ControlsLicenceId": "91846d9a-6d1f-4857-80a4-77f43414db56",
      "IsLicence": true,
      "LicenceNo": "sample string 3",
      "LicenceExpiryDate": "sample string 4",
      "Contact": {
        "$ref": "2"
      },
      "IsDeleted": true
    },
    "FinancialArrangement": {
      "$id": "19",
      "FinancialId": "7672f281-0a16-49a2-b175-88f092169f17",
      "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": "2"
      }
    },
    "Supplier": {
      "$id": "20",
      "Id": "b840f622-82c9-429a-82e4-328c70378cfa",
      "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": "2"
      }
    },
    "Logistic": {
      "$id": "21",
      "Id": "5f399c57-df9c-4773-b74a-ca2e21835e1d",
      "EmailForQuote": "sample string 2",
      "IsLogisticQuote": true,
      "IsLogisticFirm": true,
      "Contact": {
        "$ref": "2"
      }
    },
    "Category": {
      "$id": "22",
      "CategoryId": "15d77567-e41b-49fb-929d-9d5eb25e1433",
      "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": "2"
      }
    },
    "ContactFiles": {
      "$id": "23",
      "$values": [
        {
          "$id": "24",
          "ContactFileId": "304bc5c9-3988-46eb-9576-ae72768ddbe0",
          "ContactSaveId": "9d17400d-20b0-4c61-b60e-249cc9823726",
          "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": "2"
          }
        },
        {
          "$ref": "24"
        },
        {
          "$ref": "24"
        }
      ]
    },
    "ContactMethod": {
      "$id": "25",
      "ContactMethodId": "4c706aed-858b-48ad-b508-2c69fa4db6ae",
      "LinkedIn": "sample string 2",
      "Twitter": "sample string 3",
      "FaceBook": "sample string 4",
      "IM": {
        "$id": "26",
        "$values": [
          {
            "$id": "27",
            "Id": 1,
            "Message": "sample string 2",
            "IMType": "sample string 3",
            "ContactMethodId": "ccd378bb-cdd5-4d45-bc7e-94f87045f8f3",
            "ContactMethod": {
              "$ref": "25"
            },
            "IsDeleted": true
          },
          {
            "$ref": "27"
          },
          {
            "$ref": "27"
          }
        ]
      },
      "Contact": {
        "$ref": "2"
      }
    },
    "BuyingCriteria": {
      "$id": "28",
      "CriteriaId": "77eaca04-1d1f-4cf7-9cd3-5ae0da0b6140",
      "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": "2"
      }
    },
    "SaleApproach": {
      "$id": "29",
      "Id": "61ee2fca-57b8-4bcc-aad1-386d3a1e49fd",
      "GiveDiscounts": "sample string 2",
      "ContactEvery": "sample string 3",
      "EmailMarketing": "sample string 4",
      "CurrentSupplier": "sample string 5",
      "Competitor": "sample string 6",
      "Competitors": {
        "$id": "30",
        "$values": [
          {
            "$id": "31",
            "Id": 1,
            "CompetitorName": "sample string 2",
            "SaleId": "c70af160-8827-4a27-811f-de10f304d08e",
            "SaleApproach": {
              "$ref": "29"
            },
            "IsDeleted": true
          },
          {
            "$ref": "31"
          },
          {
            "$ref": "31"
          }
        ]
      },
      "Suppliers": {
        "$id": "32",
        "$values": [
          {
            "$id": "33",
            "Id": 1,
            "SupplierName": "sample string 2",
            "SaleId": "971f461e-274b-4e22-8d24-4dd207396518",
            "SaleApproach": {
              "$ref": "29"
            },
            "IsDeleted": true
          },
          {
            "$ref": "33"
          },
          {
            "$ref": "33"
          }
        ]
      },
      "OurRelationship": "sample string 7",
      "RelationshipMgr": "sample string 8",
      "Contact": {
        "$ref": "2"
      }
    },
    "AppendNotes": {
      "$id": "34",
      "$values": [
        {
          "$id": "35",
          "AppendNoteId": 1,
          "CreatedDate": "2026-02-04T02:39:47.5589469+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": "f14ced06-c23d-4681-819e-8b53b7f79358",
          "Contact": {
            "$ref": "2"
          }
        },
        {
          "$ref": "35"
        },
        {
          "$ref": "35"
        }
      ]
    },
    "Event": {
      "$id": "36",
      "$values": [
        {
          "$ref": "1"
        },
        {
          "$ref": "1"
        },
        {
          "$ref": "1"
        }
      ]
    },
    "CreatedTimestamp": "2026-02-04T02:39:47.5589469+00:00",
    "IsClient": true,
    "RpsStatus": "sample string 21",
    "RpsUpdatedDate": "2026-02-04T02:39:47.5589469+00:00",
    "PersonalInformation": {
      "$id": "37",
      "PersonalId": "3e95986c-f64a-43ee-bbbc-ecf5f060eaa9",
      "Gender": "sample string 1",
      "DateOfBirth": "2026-02-04T02:39:47.5589469+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": "2"
      }
    },
    "MinExpiryDays": 22,
    "CountryList": {
      "$id": "38",
      "$values": [
        {
          "$id": "39",
          "Id": 1,
          "CountryCode": "sample string 2",
          "Name": "sample string 3",
          "Type": "sample string 4"
        },
        {
          "$ref": "39"
        },
        {
          "$ref": "39"
        }
      ]
    },
    "XeroId": "4fef697c-5efc-4224-a69f-d916f9a2d476",
    "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": "2026-02-04T02:39:47.5589469+00:00",
    "OrganisationId": "sample string 35",
    "Main": true,
    "WBSBookingId": "81ae007a-cad5-48a4-9e50-f79b3b30d255",
    "WBSFirmSaveId": "ea14c4a8-f543-4eb7-9bff-16e9ec3a17ff",
    "WBSDriverSaveId": "75e24ceb-fd4b-4627-90e7-04b7a6a27ba7",
    "WBSUserId": "e0abbe2c-3d88-4bed-b3e0-fd3ff9eda88a",
    "WBSUserSaveId": "f51b924f-ee0a-4ba9-b72c-f47aa9a1fe00"
  }
}

application/xml

Sample:

An exception has occurred while using the formatter 'XmlMediaTypeFormatter' to generate sample for media type 'application/xml'. Exception message: One or more errors occurred.

text/xml

Sample:

An exception has occurred while using the formatter 'XmlMediaTypeFormatter' to generate sample for media type 'text/xml'. Exception message: One or more errors occurred.

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'Event'.

Response Information

No documentation available.

Response body formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.