Billhighway Cloud API

<back to all web services

SalesForceMemberCollection

The following routes are available for this service:
POST/api/SalesForce/Member
SalesForceMemberCollection Parameters:
NameParameterData TypeRequiredDescription
MembersbodyList<SalesForceMember>No
SalesForceMember Parameters:
NameParameterData TypeRequiredDescription
ClassNameformstringNo
UniqueIdformstringNo
CreatedDateTimeformDateTimeNo
ClientIdformintNo
GroupIdformstringNo
UserIdformstringNo
AlternateUserIdformstringNo
BhUserIdformintNo
FirstNameformstringNo
LastNameformstringNo
MiddleNameformstringNo
PreferredEmailAddressformstringNo
OtherEmailAddressformstringNo
PreferredPhoneNumberformstringNo
PreferredAddress1formstringNo
PreferredAddress2formstringNo
PreferredCityformstringNo
PreferredStateformstringNo
PreferredZipformstringNo
PreferredCountryformstringNo
AccessLevelformstringNo
MemberStatusformstringNo
MemberTypeClientformstringNo
BillingTypeformstringNo
FiscalYearformintNo
WorkLocationformstringNo
DOBformDateTimeNo
PaperlessformstringNo
DisplayNameformstringNo
DisableLoginformstringNo
RecurringInvoiceSettingsformRecurringInvoiceSettingsNo
FormFieldsformList<SubscriberFormField>No
AttributesformList<AttributeItem>No
GroupListformList<Chapter>No
RecurringInvoiceSettings Parameters:
NameParameterData TypeRequiredDescription
DonationAmountformstringNo
SubscriberFormField Parameters:
NameParameterData TypeRequiredDescription
NameformstringNo
ValueformstringNo
AttributeItem Parameters:
NameParameterData TypeRequiredDescription
NameformstringNo
ValueformstringNo
Chapter Parameters:
NameParameterData TypeRequiredDescription
GroupIdformstringNo
SalesForceMemberReplyCollection Parameters:
NameParameterData TypeRequiredDescription
MemberReplyformList<SalesForceMemberReply>No
IsErrorformboolNo
SalesForceMemberReply Parameters:
NameParameterData TypeRequiredDescription
ClassNameformstringNo
UniqueIdformstringNo
CreatedDateTimeformDateTimeNo
ClientIdformintNo
ErrorCodeformintNo
ErrorMessageformstringNo
BillhighwayuserIdformintNo
UserIdformstringNo
GroupIdformstringNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /api/SalesForce/Member HTTP/1.1 
Host: devapi.billhighway.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"Members":[{"ClassName":"String","UniqueId":"String","CreatedDateTime":"0001-01-01T00:00:00.0000000","ClientId":0,"GroupId":"String","UserId":"String","AlternateUserId":"String","BhUserId":0,"FirstName":"String","LastName":"String","MiddleName":"String","PreferredEmailAddress":"String","OtherEmailAddress":"String","PreferredPhoneNumber":"String","PreferredAddress1":"String","PreferredAddress2":"String","PreferredCity":"String","PreferredState":"String","PreferredZip":"String","PreferredCountry":"String","AccessLevel":"String","MemberStatus":"String","MemberTypeClient":"String","BillingType":"String","FiscalYear":0,"WorkLocation":"String","DOB":"0001-01-01T00:00:00.0000000","Paperless":"String","DisplayName":"String","DisableLogin":"String","RecurringInvoiceSettings":{"DonationAmount":"String"},"FormFields":[{"Name":"String","Value":"String"}],"Attributes":[{"Name":"String","Value":"String"}],"GroupList":[{"GroupId":"String"}]}]}

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"MemberReply":[{"ClassName":"String","UniqueId":"String","CreatedDateTime":"0001-01-01T00:00:00.0000000","ClientId":0,"ErrorCode":0,"ErrorMessage":"String","BillhighwayuserId":0,"UserId":"String","GroupId":"String"}],"IsError":false}