POST api/Phone

Updates or Adds a phone number on an account

Request Information

URI Parameters

None.

Body Parameters

The phone object to insert or add

Phone
NameDescriptionTypeAdditional information
SecureSystemId

integer

None.

Id

integer

None.

AccountId

integer

None.

CountryPrefix

string

None.

AreaCode

string

None.

PhoneNumber

string

None.

Extension

string

None.

IsPrimary

boolean

None.

IsActive

boolean

None.

PhoneTypeId

integer

None.

Request Formats

application/json, text/json

Sample:
{
  "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:
<Phone xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Caf.DonorCloud.Entities">
  <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>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ApiResult
NameDescriptionTypeAdditional 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.