PATCH

apiportal/v1/Community/{communityid}

Update community member - replaces only supplied parameters

Request Information

Roles

Vendor_APIClient

URI Parameters

Name	Description	Type	Additional information
communityid	Community ID	integer	Required

Body Parameters

Community update details

spuCommunity

Name	Type	Additional information
Title	string	None.
Preferred	string	None.
Given1	string	None.
Given2	string	None.
Surname	string	None.
Gender	string	None.
Email	string	None.
MobilePhone	string	None.
OccupPhone	string	None.
OccupFax	string	None.
OccupEmail	string	None.
OccupCode	string	None.
OccupDesc	string	None.
OccupCompany	string	None.
OccupCompanyAttn	string	None.
OccupIndustry	string	None.
OccupPosition	string	None.
BirthDate	date	None.
Education	string	None.
Qualifications	string	None.
HighestSecondaryYearLevel	integer	None.
LastYearOfStudy	integer	None.
MailFormat	string	None.
Religion	string	None.

Request Formats

{
  "Title": "sample string 1",
  "Preferred": "sample string 2",
  "Given1": "sample string 3",
  "Given2": "sample string 4",
  "Surname": "sample string 5",
  "Gender": "sample string 6",
  "Email": "sample string 7",
  "MobilePhone": "sample string 8",
  "OccupPhone": "sample string 9",
  "OccupFax": "sample string 10",
  "OccupEmail": "sample string 11",
  "OccupCode": "sample string 12",
  "OccupDesc": "sample string 13",
  "OccupCompany": "sample string 14",
  "OccupCompanyAttn": "sample string 15",
  "OccupIndustry": "sample string 16",
  "OccupPosition": "sample string 17",
  "BirthDate": "2025-12-16T11:55:53.476281+11:00",
  "Education": "sample string 18",
  "Qualifications": "sample string 19",
  "HighestSecondaryYearLevel": 1,
  "LastYearOfStudy": 1,
  "MailFormat": "sample string 20",
  "Religion": "sample string 21"
}

<spuCommunity xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Synergetic.Model.APIClient">
  <BirthDate>2025-12-16T11:55:53.476281+11:00</BirthDate>
  <Education>sample string 18</Education>
  <Email>sample string 7</Email>
  <Gender>sample string 6</Gender>
  <Given1>sample string 3</Given1>
  <Given2>sample string 4</Given2>
  <HighestSecondaryYearLevel>1</HighestSecondaryYearLevel>
  <LastYearOfStudy>1</LastYearOfStudy>
  <MailFormat>sample string 20</MailFormat>
  <MobilePhone>sample string 8</MobilePhone>
  <OccupCode>sample string 12</OccupCode>
  <OccupCompany>sample string 14</OccupCompany>
  <OccupCompanyAttn>sample string 15</OccupCompanyAttn>
  <OccupDesc>sample string 13</OccupDesc>
  <OccupEmail>sample string 11</OccupEmail>
  <OccupFax>sample string 10</OccupFax>
  <OccupIndustry>sample string 16</OccupIndustry>
  <OccupPhone>sample string 9</OccupPhone>
  <OccupPosition>sample string 17</OccupPosition>
  <Preferred>sample string 2</Preferred>
  <Qualifications>sample string 19</Qualifications>
  <Religion>sample string 21</Religion>
  <Surname>sample string 5</Surname>
  <Title>sample string 1</Title>
</spuCommunity>

Sample not available.

Response Information

Resource Description

ChangeEntitySeqModel

Name	Type	Additional information
EntitySeq	integer	None.
Error	string	None.
ValidationDetails	Collection of ValidationDetails	None.

{
  "EntitySeq": 1,
  "Error": "sample string 1",
  "ValidationDetails": [
    {
      "FieldName": "sample string 1",
      "Reason": "sample string 2"
    },
    {
      "FieldName": "sample string 1",
      "Reason": "sample string 2"
    }
  ]
}

<ChangeEntitySeqModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Synergetic.Model.APIClient">
  <Error>sample string 1</Error>
  <ValidationDetails>
    <ValidationDetails>
      <FieldName>sample string 1</FieldName>
      <Reason>sample string 2</Reason>
    </ValidationDetails>
    <ValidationDetails>
      <FieldName>sample string 1</FieldName>
      <Reason>sample string 2</Reason>
    </ValidationDetails>
  </ValidationDetails>
  <EntitySeq>1</EntitySeq>
</ChangeEntitySeqModel>