POST api/BusinessPartner

Upserts a business partner for an account

Request Information

URI Parameters

None.

Body Parameters

The business partner to add/update

Name	Type	Additional information
Id	integer	None.
AccountId	integer	None.
DisplayName	string	None.
Description	string	None.
WebsiteUrl	string	None.
DisplayAddressId	integer	None.
CategoryId	integer	None.
SystemId	integer	None.
PhoneId	integer	None.
BusinessCategory	BusinessCategory	None.
Address	Address	None.
Phone	Phone	None.

Request Formats

application/json, text/json

Sample:

{
  "Id": 1,
  "AccountId": 2,
  "DisplayName": "sample string 3",
  "Description": "sample string 4",
  "WebsiteUrl": "sample string 5",
  "DisplayAddressId": 1,
  "CategoryId": 6,
  "SystemId": 1,
  "PhoneId": 1,
  "BusinessCategory": {
    "CategoryId": 1,
    "Category": "sample string 2",
    "CategoryDescription": "sample string 3",
    "DisplayOrder": 4
  },
  "Address": {
    "SecureSystemAddressId": 1,
    "AcceptAddress": true,
    "Id": 2,
    "AccountId": 3,
    "Line1": "sample string 4",
    "Line2": "sample string 5",
    "Line3": "sample string 6",
    "Line4": "sample string 7",
    "ZipCode": "sample string 8",
    "Country": "sample string 9",
    "StateProvince": "sample string 10",
    "City": "sample string 11",
    "AddressTypeId": 12
  },
  "Phone": {
    "SecureSystemId": 1,
    "Id": 1,
    "AccountId": 2,
    "CountryPrefix": "sample string 3",
    "AreaCode": "sample string 4",
    "PhoneNumber": "sample string 5",
    "Extension": "sample string 6",
    "IsPrimary": true,
    "IsActive": true,
    "PhoneTypeId": 1
  }
}

application/xml, text/xml

Sample:

<BusinessPartner xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Caf.DonorCloud.Entities">
  <AccountId>2</AccountId>
  <Address>
    <AcceptAddress>true</AcceptAddress>
    <AccountId>3</AccountId>
    <AddressTypeId>12</AddressTypeId>
    <City>sample string 11</City>
    <Country>sample string 9</Country>
    <Id>2</Id>
    <Line1>sample string 4</Line1>
    <Line2>sample string 5</Line2>
    <Line3>sample string 6</Line3>
    <Line4>sample string 7</Line4>
    <SecureSystemAddressId>1</SecureSystemAddressId>
    <StateProvince>sample string 10</StateProvince>
    <ZipCode>sample string 8</ZipCode>
  </Address>
  <BusinessCategory>
    <Category>sample string 2</Category>
    <CategoryDescription>sample string 3</CategoryDescription>
    <CategoryId>1</CategoryId>
    <DisplayOrder>4</DisplayOrder>
  </BusinessCategory>
  <CategoryId>6</CategoryId>
  <Description>sample string 4</Description>
  <DisplayAddressId>1</DisplayAddressId>
  <DisplayName>sample string 3</DisplayName>
  <Id>1</Id>
  <Phone>
    <AccountId>2</AccountId>
    <AreaCode>sample string 4</AreaCode>
    <CountryPrefix>sample string 3</CountryPrefix>
    <Extension>sample string 6</Extension>
    <Id>1</Id>
    <IsActive>true</IsActive>
    <IsPrimary>true</IsPrimary>
    <PhoneNumber>sample string 5</PhoneNumber>
    <PhoneTypeId>1</PhoneTypeId>
    <SecureSystemId>1</SecureSystemId>
  </Phone>
  <PhoneId>1</PhoneId>
  <SystemId>1</SystemId>
  <WebsiteUrl>sample string 5</WebsiteUrl>
</BusinessPartner>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Error Information related to the upsert

ApiResult

Name	Description	Type	Additional information
HasErrors	True if there are any errors present	boolean	None.
Errors	The list of errors	Collection of ApiResultError	None.

Response Formats

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

Sample:

Sample not available.