Use Cases for Individual

I want to
Request TypeExample URL
Retrieve and display details of a particular individual.GET by ID{{orgendpoint}}/services/data/{{version}}/connect/comms/partymanagement/v5/individual/{ID}

NOTE:
For an invalid ID, you receive HTTP 404 error.
Based on the provided field values, retrieve and display details of individuals.GET with Fields{{orgendpoint}}/services/data/{{version}}/connect/comms/partymanagement/v5/individual?fields=name

NOTE:
The requested fields are part of the output if they have a value.
List all the individuals present in the system.GET List{{orgendpoint}}/services/data/{{version}}/connect/comms/partymanagement/v5/individual
List individuals present in the system based on the filter applied.GET List with Filtering{{orgendpoint}}/services/data/{{version}}/connect/comms/partymanagement/v5/individual?name=John Doe

NOTE:
The requested fields are part of the output if they have a value.
List individuals, limit the number of records to a specified limit, and start the results from the page specified by offset.GET List by limit and offset{{orgendpoint}}/services/data/{{version}}/connect/comms/partymanagement/v5/individual?offset=4&pageLimit=1&pageinfo=true
Create a new individual by providing the required details.POST{{orgendpoint}}/services/data/{{version}}/connect/comms/partymanagement/v5/individual

NOTE:
A new individual is created based on the values mentioned for the mandatory fields.
Update details of a particular individual.PATCH{{orgendpoint}}/services/data/{{version}}/connect/comms/partymanagement/v5/individual/{ID}
Delete an individual.DELETE{{orgendpoint}}/services/data/{{version}}/connect/comms/partymanagement/v5/individual/{ID}

NOTE:
DELETE requires an Apex extensibility implementation. Without it, the API returns HTTP 400.

Consider you want to retrieve details of a particular individual.

{{orgendpoint}}/services/data/{{version}}/connect/comms/partymanagement/v5/individual/{ID}

Consider you want to retrieve individuals and return only these fields in the output.

  • id
  • name

{{orgendpoint}}/services/data/{{version}}/connect/comms/partymanagement/v5/individual?fields=name

Consider there are multiple individuals in the system and you want to list all of them.

{{orgendpoint}}/services/data/{{version}}/connect/comms/partymanagement/v5/individual

Consider you want to retrieve individuals with applied filter values.

{{orgendpoint}}/services/data/{{version}}/connect/comms/partymanagement/v5/individual?name=John Doe

Consider you want to retrieve a list of individuals, limit the number of records, and start the results from the specified offset.

{{orgendpoint}}/services/data/{{version}}/connect/comms/partymanagement/v5/individual?offset=4&pageLimit=1&pageinfo=true

Consider you want to create a new individual. givenName and familyName are mandatory.

{{orgendpoint}}/services/data/{{version}}/connect/comms/partymanagement/v5/individual

Consider you want to update details of a particular individual. Patchable attributes include givenName, familyName, title, birthDate, contactMedium, and relatedParty. These attributes are not patchable: id, href, name, and @type.

{{orgendpoint}}/services/data/{{version}}/connect/comms/partymanagement/v5/individual/{ID}

Contact and Account do not include a status field that supports soft delete out of the box. The DELETE endpoint is provided as an extensibility hook. Without a custom Apex implementation, the API returns HTTP 400.

{{orgendpoint}}/services/data/{{version}}/connect/comms/partymanagement/v5/individual/{ID}

No request body.

With an Apex extensibility implementation: HTTP 204 with no response body.

Without extensibility: