Use Cases for Organization

GET by ID

Consider you want to retrieve details of a particular organization.

Sample URL

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

Sample Response

{
    "id": "001xx000003GkRbAAK",
    "href": "/connect/comms/partymanagement/v5/organization/001xx000003GkRbAAK",
    "name": "Acme Corporation",
    "organizationType": "Partner",
    "contactMedium": [
        {
            "phoneNumber": "+1-555-0300",
            "@type": "PhoneContactMedium"
        },
        {
            "faxNumber": "+1-555-0301",
            "@type": "FaxContactMedium"
        },
        {
            "city": "San Francisco",
            "country": "US",
            "postCode": "94105",
            "stateOrProvince": "CA",
            "street1": "1 Market Street",
            "@type": "GeographicAddressContactMedium"
        }
    ],
    "@type": "Organization"
}

GET with Fields

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

• name
• organizationType

Sample URL

{{orgendpoint}}/services/data/{{version}}/connect/comms/partymanagement/v5/organization?fields=name,organizationType

Sample Response

[
    {
        "id": "001xx000003GkRbAAK",
        "href": "/connect/comms/partymanagement/v5/organization/001xx000003GkRbAAK",
        "name": "Acme Corporation",
        "organizationType": "Partner",
        "@type": "Organization"
    }
]

GET List

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

Sample URL

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

GET List with Filtering

Consider you want to retrieve organizations with applied filter values.

Sample URL

{{orgendpoint}}/services/data/{{version}}/connect/comms/partymanagement/v5/organization?name=Acme

Sample Response

[
    {
        "id": "001xx000003GkRbAAK",
        "href": "/connect/comms/partymanagement/v5/organization/001xx000003GkRbAAK",
        "name": "Acme Corporation",
        "organizationType": "Partner",
        "@type": "Organization"
    }
]

GET List by limit and offset

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

Sample URL

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

POST

Consider you want to create a new organization. name is mandatory.

Sample URL

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

Sample Request

{
    "@type": "Organization",
    "name": "Minimal Org"
}

Sample Response

{
    "id": "001xx000003H8NWAA0",
    "href": "/connect/comms/partymanagement/v5/organization/001xx000003H8NWAA0",
    "name": "Minimal Org",
    "@type": "Organization"
}

PATCH

Consider you want to update details of a particular organization.

Sample URL

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

Sample Request

{
    "@type": "Organization",
    "name": "Acme Corp Updated",
    "contactMedium": [
        {
            "@type": "PhoneContactMedium",
            "phoneNumber": "+1-555-0400"
        },
        {
            "@type": "GeographicAddressContactMedium",
            "street1": "789 Pine Road",
            "city": "Austin",
            "stateOrProvince": "TX",
            "postCode": "73301",
            "country": "US"
        }
    ],
    "organizationParentRelationship": {
        "organization": {
            "id": "001xx000003GkTDAA0"
        }
    }
}

DELETE

Account does 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.

Sample URL

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

Sample Request

No request body.

Sample Response

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

Without extensibility:

[
    {
        "errorCode": "BAD_REQUEST",
        "message": "DELETE operation for organisation requires an extensibility class implementing comms_apex_ext.IOrganizationPartyManagementDELETE. Configure a custom Apex class that provides a soft-delete status field via the customiseMutationPayload hook."
    }
]