Address Purposes REST Endpoints

Sort by

Task Path Method

Households/Addresses/Address Purposes

The address purposes resource is used to view, create, update, and delete the address purpose. The address purpose describes the type of an address, such as a shipping address or a billing address.

Create an address purpose

Method: post

Path: /crmRestApi/resources/11.13.18.05/households/{PartyNumber}/child/Address/{AddressNumber}/child/AddressPurpose

Delete an address purpose

Method: delete

Path: /crmRestApi/resources/11.13.18.05/households/{PartyNumber}/child/Address/{AddressNumber}/child/AddressPurpose/{AddressPurposeId}

Get all address purposes

Method: get

Path: /crmRestApi/resources/11.13.18.05/households/{PartyNumber}/child/Address/{AddressNumber}/child/AddressPurpose

Get an address purpose

Method: get

Path: /crmRestApi/resources/11.13.18.05/households/{PartyNumber}/child/Address/{AddressNumber}/child/AddressPurpose/{AddressPurposeId}

Update an address purpose

Method: patch

Path: /crmRestApi/resources/11.13.18.05/households/{PartyNumber}/child/Address/{AddressNumber}/child/AddressPurpose/{AddressPurposeId}