REST API for Oracle Loyalty Cloud

All REST Endpoints

(Deprecated) Loyalty Member Enrollments

The loyalty member enrollment resource is used to retrieve the loyalty promotion enrolment details for a given loyalty member.

Create a loyalty promotion enrollment collection for a member (Deprecated): Method: post
Path: /crmRestApi/resources/11.13.18.05/loyaltyMemberEnrollments
Delete a loyalty promotion to which a member is enrolled (Deprecated): Method: delete
Path: /crmRestApi/resources/11.13.18.05/loyaltyMemberEnrollments/{LoyPromomemId}
Get a loyalty promotion to which a member is enrolled (Deprecated): Method: get
Path: /crmRestApi/resources/11.13.18.05/loyaltyMemberEnrollments/{LoyPromomemId}
Get all loyalty promotions to which a member is enrolled (Deprecated): Method: get
Path: /crmRestApi/resources/11.13.18.05/loyaltyMemberEnrollments
Update a loyalty promotion to which a member is enrolled (Deprecated): Method: patch
Path: /crmRestApi/resources/11.13.18.05/loyaltyMemberEnrollments/{LoyPromomemId}

(Deprecated) Loyalty Members

The loyalty member resource is used to retrieve the loyalty member details for a given loyalty program.

Create a loyalty member (Deprecated): Method: post
Path: /crmRestApi/resources/11.13.18.05/loyaltyMembers
Get a loyalty member (Deprecated): Method: get
Path: /crmRestApi/resources/11.13.18.05/loyaltyMembers/{MemberNumber}
Get all loyalty members (Deprecated): Method: get
Path: /crmRestApi/resources/11.13.18.05/loyaltyMembers
Update a loyalty member (Deprecated): Method: patch
Path: /crmRestApi/resources/11.13.18.05/loyaltyMembers/{MemberNumber}

(Deprecated) Loyalty Members/(Deprecated) Member Attributes

The member attribute resource is used to retrieve the details of a member attribute associated with the loyalty member.

Get a member attribute (Deprecated): Method: get
Path: /crmRestApi/resources/11.13.18.05/loyaltyMembers/{MemberNumber}/child/MemberAttributes/{LoyAttribId}
Get all member attribute (Deprecated): Method: get
Path: /crmRestApi/resources/11.13.18.05/loyaltyMembers/{MemberNumber}/child/MemberAttributes

(Deprecated) Loyalty Members/(Deprecated) Member Contacts

The member contact resource is used to retrieve the details of a contact that is associated with the loyalty member.

Get a contact (Deprecated): Method: get
Path: /crmRestApi/resources/11.13.18.05/loyaltyMembers/{MemberNumber}/child/MemberContacts/{MemberContactsUniqID}
Get all contacts (Deprecated): Method: get
Path: /crmRestApi/resources/11.13.18.05/loyaltyMembers/{MemberNumber}/child/MemberContacts

(Deprecated) Loyalty Members/(Deprecated) Member Point Balances

The point balance resource is used to retrieve the point balance detail for a loyalty member.

Create a point balance (Deprecated): Method: post
Path: /crmRestApi/resources/11.13.18.05/loyaltyMembers/{MemberNumber}/child/PointBalances
Delete a point balance (Deprecated): Method: delete
Path: /crmRestApi/resources/11.13.18.05/loyaltyMembers/{MemberNumber}/child/PointBalances/{LoyAttrdefnBId}
Get a point balance (Deprecated): Method: get
Path: /crmRestApi/resources/11.13.18.05/loyaltyMembers/{MemberNumber}/child/PointBalances/{LoyAttrdefnBId}
Get all point balances (Deprecated): Method: get
Path: /crmRestApi/resources/11.13.18.05/loyaltyMembers/{MemberNumber}/child/PointBalances
Update a point balance (Deprecated): Method: patch
Path: /crmRestApi/resources/11.13.18.05/loyaltyMembers/{MemberNumber}/child/PointBalances/{LoyAttrdefnBId}

(Deprecated) Loyalty Members/(Deprecated) Member Promotion Attributes

The member promotion attribute resource is used to retrieve the details of a member promotion attribute associated with the loyalty member.

Get a promotion attribute (Deprecated): Method: get
Path: /crmRestApi/resources/11.13.18.05/loyaltyMembers/{MemberNumber}/child/MemberPromotionAttributes/{LoyAttrdefnBId}
Get all promotion attribute (Deprecated): Method: get
Path: /crmRestApi/resources/11.13.18.05/loyaltyMembers/{MemberNumber}/child/MemberPromotionAttributes

(Deprecated) Loyalty Members/(Deprecated) Member Promotions

The member promotion resource is used to retrieve the details of a promotion enrolled by the loyalty member.

Get a enrolled promotion (Deprecated): Method: get
Path: /crmRestApi/resources/11.13.18.05/loyaltyMembers/{MemberNumber}/child/MemberPromotions/{LoyPromomemId}
Get all enrolled promotion (Deprecated): Method: get
Path: /crmRestApi/resources/11.13.18.05/loyaltyMembers/{MemberNumber}/child/MemberPromotions

(Deprecated) Loyalty Members/(Deprecated) Member Referrals

The member referral resource is used to retrieve the contacts that are referred by the loyalty member.

Create a referral (Deprecated): Method: post
Path: /crmRestApi/resources/11.13.18.05/loyaltyMembers/{MemberNumber}/child/MemberReferrals
Delete a referral (Deprecated): Method: delete
Path: /crmRestApi/resources/11.13.18.05/loyaltyMembers/{MemberNumber}/child/MemberReferrals/{LoyMemberId}
Get a referral (Deprecated): Method: get
Path: /crmRestApi/resources/11.13.18.05/loyaltyMembers/{MemberNumber}/child/MemberReferrals/{LoyMemberId}
Get all referrals (Deprecated): Method: get
Path: /crmRestApi/resources/11.13.18.05/loyaltyMembers/{MemberNumber}/child/MemberReferrals
Update a referral (Deprecated): Method: patch
Path: /crmRestApi/resources/11.13.18.05/loyaltyMembers/{MemberNumber}/child/MemberReferrals/{LoyMemberId}

(Deprecated) Loyalty Members/(Deprecated) Member Tiers

The member tier resource is used to retrieve the member tier details for a loyalty member.

Create a tier (Deprecated): Method: post
Path: /crmRestApi/resources/11.13.18.05/loyaltyMembers/{MemberNumber}/child/MemberTiers
Delete a tier (Deprecated): Method: delete
Path: /crmRestApi/resources/11.13.18.05/loyaltyMembers/{MemberNumber}/child/MemberTiers/{MemberTiersUniqID}
Get a tier (Deprecated): Method: get
Path: /crmRestApi/resources/11.13.18.05/loyaltyMembers/{MemberNumber}/child/MemberTiers/{MemberTiersUniqID}
Get all tiers (Deprecated): Method: get
Path: /crmRestApi/resources/11.13.18.05/loyaltyMembers/{MemberNumber}/child/MemberTiers
Update a tier (Deprecated): Method: patch
Path: /crmRestApi/resources/11.13.18.05/loyaltyMembers/{MemberNumber}/child/MemberTiers/{MemberTiersUniqID}

(Deprecated) Loyalty Members/(Deprecated) Member Transactions

The transaction resource is used to retrieve the details of transactions performed by the loyalty member.

Create a transaction (Deprecated): Method: post
Path: /crmRestApi/resources/11.13.18.05/loyaltyMembers/{MemberNumber}/child/MemberTransactions
Delete a transaction (Deprecated): Method: delete
Path: /crmRestApi/resources/11.13.18.05/loyaltyMembers/{MemberNumber}/child/MemberTransactions/{LoyTransactionId}
Get a transaction (Deprecated): Method: get
Path: /crmRestApi/resources/11.13.18.05/loyaltyMembers/{MemberNumber}/child/MemberTransactions/{LoyTransactionId}
Get all transactions (Deprecated): Method: get
Path: /crmRestApi/resources/11.13.18.05/loyaltyMembers/{MemberNumber}/child/MemberTransactions
Update a transaction (Deprecated): Method: patch
Path: /crmRestApi/resources/11.13.18.05/loyaltyMembers/{MemberNumber}/child/MemberTransactions/{LoyTransactionId}

(Deprecated) Loyalty Members/(Deprecated) Member Vouchers

The member voucher resource is used to retrieve the vouchers that are assigned to a loyalty member.

Create a voucher (Deprecated): Method: post
Path: /crmRestApi/resources/11.13.18.05/loyaltyMembers/{MemberNumber}/child/MemberVouchers
Delete a voucher (Deprecated): Method: delete
Path: /crmRestApi/resources/11.13.18.05/loyaltyMembers/{MemberNumber}/child/MemberVouchers/{LoyMemVchrId}
Get a voucher (Deprecated): Method: get
Path: /crmRestApi/resources/11.13.18.05/loyaltyMembers/{MemberNumber}/child/MemberVouchers/{LoyMemVchrId}
Get all vouchers (Deprecated): Method: get
Path: /crmRestApi/resources/11.13.18.05/loyaltyMembers/{MemberNumber}/child/MemberVouchers
Update a voucher (Deprecated): Method: patch
Path: /crmRestApi/resources/11.13.18.05/loyaltyMembers/{MemberNumber}/child/MemberVouchers/{LoyMemVchrId}

(Deprecated) Loyalty Transactions

The loyalty transactions resource is used to retrieve the details of a loyalty transaction.

Get a loyalty transaction (Deprecated): Method: get
Path: /crmRestApi/resources/11.13.18.05/loyaltyTransactions/{LoyTransactionId}
Get all loyalty transactions (Deprecated): Method: get
Path: /crmRestApi/resources/11.13.18.05/loyaltyTransactions
Process a loyalty transaction (Deprecated): Method: post
Path: /crmRestApi/resources/11.13.18.05/loyaltyTransactions
Processes a loyalty transaction for a given transaction number.: Method: post
Path: /crmRestApi/resources/11.13.18.05/loyaltyTransactions/action/processTransaction
Update a loyalty transaction (Deprecated): Method: patch
Path: /crmRestApi/resources/11.13.18.05/loyaltyTransactions/{LoyTransactionId}

(Deprecated) Loyalty Transactions/(Deprecated) Accrual Items

The accrual items resource is used to retrieve the accrual items that have been updated on transaction processing.

Get a loyalty accrual item detail updated during transaction processing (Deprecated): Method: get
Path: /crmRestApi/resources/11.13.18.05/loyaltyTransactions/{LoyTransactionId}/child/AccrualItems/{AccrualItemsUniqID}
Get all loyalty accrual items updated during transaction processing (Deprecated): Method: get
Path: /crmRestApi/resources/11.13.18.05/loyaltyTransactions/{LoyTransactionId}/child/AccrualItems

(Deprecated) Loyalty Transactions/(Deprecated) Loyalty Promotions

The loyalty promotions resource is used to retrieve the details of a loyalty promotion that is applied to the transaction.

Get a loyalty promotion applied to a transaction (Deprecated): Method: get
Path: /crmRestApi/resources/11.13.18.05/loyaltyTransactions/{LoyTransactionId}/child/Promotions/{LoyPromoId}
Get all loyalty promotions applied to a transaction (Deprecated): Method: get
Path: /crmRestApi/resources/11.13.18.05/loyaltyTransactions/{LoyTransactionId}/child/Promotions

(Deprecated) Loyalty Transactions/(Deprecated) Loyalty Promotions/(Deprecated) Promotion Attributes

The promotion attributes resource is used to retrieve the details of a promotion attribute that is updated for transaction.

Get a loyalty promotion attribute updated during transaction processing (Deprecated): Method: get
Path: /crmRestApi/resources/11.13.18.05/loyaltyTransactions/{LoyTransactionId}/child/Promotions/{LoyPromoId}/child/PromotionAttributes/{PromotionAttributesUniqID}
Get all loyalty promotion attributes updated during transaction processing (Deprecated): Method: get
Path: /crmRestApi/resources/11.13.18.05/loyaltyTransactions/{LoyTransactionId}/child/Promotions/{LoyPromoId}/child/PromotionAttributes

(Deprecated) Loyalty Transactions/(Deprecated) Redemption Items

The redemption items resource is used to retrieve the redemption items that have been updated on transaction processing.

Get a loyalty redemption item updated during transaction processing (Deprecated): Method: get
Path: /crmRestApi/resources/11.13.18.05/loyaltyTransactions/{LoyTransactionId}/child/RedemptionItems/{RedemptionItemsUniqID}
Get all loyalty redemption items updated during transaction processing (Deprecated): Method: get
Path: /crmRestApi/resources/11.13.18.05/loyaltyTransactions/{LoyTransactionId}/child/RedemptionItems

(Deprecated) Loyalty Transactions/(Deprecated) Transaction Vouchers

The transaction vouchers resource is used to retrieve the details of loyalty vouchers that are applied to the transaction.

Get a loyalty transaction voucher assigned during transaction processing (Deprecated): Method: get
Path: /crmRestApi/resources/11.13.18.05/loyaltyTransactions/{LoyTransactionId}/child/TransactionVouchers/{LoyMemVchrId}
Get all loyalty transaction vouchers assigned during transaction processing (Deprecated): Method: get
Path: /crmRestApi/resources/11.13.18.05/loyaltyTransactions/{LoyTransactionId}/child/TransactionVouchers

(Deprecated) Loyalty Vouchers

The loyalty voucher resource is used to retrieve details on a loyalty voucher.

Create a loyalty voucher (Deprecated): Method: post
Path: /crmRestApi/resources/11.13.18.05/loyaltyVouchers
Get a voucher detail (Deprecated): Method: get
Path: /crmRestApi/resources/11.13.18.05/loyaltyVouchers/{VoucherNumber}
Get all voucher details (Deprecated): Method: get
Path: /crmRestApi/resources/11.13.18.05/loyaltyVouchers
Update a voucher status (Deprecated): Method: patch
Path: /crmRestApi/resources/11.13.18.05/loyaltyVouchers/{VoucherNumber}

Accounts

The accounts resource is used to view, create, update, delete, and assign accounts. An account is an entity with whom you have a selling relationship.

Assign accounts: Method: post
Path: /crmRestApi/resources/11.13.18.05/accounts/action/runAssignment
Create an account: Method: post
Path: /crmRestApi/resources/11.13.18.05/accounts
Delete an account: Method: delete
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}
Find duplicates: Method: post
Path: /crmRestApi/resources/11.13.18.05/accounts/action/findDuplicates
Get all accounts: Method: get
Path: /crmRestApi/resources/11.13.18.05/accounts
Get an account: Method: get
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}
Update an account: Method: patch
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}

Accounts/Account Attachments

The account attachments resource is used to view, create, update, and delete attachments of an account. An attachment includes additional information about an account.

Get all attachments: Method: get
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/Attachment
Get an attachment: Method: get
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/Attachment/{AttachmentUniqID}
Remove an attachment: Method: delete
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/Attachment/{AttachmentUniqID}
Replace an attachment: Method: patch
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/Attachment/{AttachmentUniqID}
Upload an attachment: Method: post
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/Attachment

Accounts/Account Attachments/Large Object (LOB) Attributes - FileContents

The contents of the attachment.

Delete a FileContents: Method: delete
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/Attachment/{AttachmentUniqID}/enclosure/FileContents
Get a FileContents: Method: get
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/Attachment/{AttachmentUniqID}/enclosure/FileContents
Replace a FileContents: Method: put
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/Attachment/{AttachmentUniqID}/enclosure/FileContents

Accounts/Account Attachments/Large Object (LOB) Attributes - FileWebImage

Get a FileWebImage: Method: get
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/Attachment/{AttachmentUniqID}/enclosure/FileWebImage

Accounts/Account Extension Bases

The account extension bases resource is used to view, create, update, and delete an account extension base. It serves as the base object for all the extension local objects that belong to the same extension type.

Create an account extension base: Method: post
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/AccountExtensionBase
Delete an account extension base: Method: delete
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/AccountExtensionBase/{Id}
Get all account extension bases: Method: get
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/AccountExtensionBase
Get an account extension base: Method: get
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/AccountExtensionBase/{Id}
Update an account extension base: Method: patch
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/AccountExtensionBase/{Id}

Accounts/Account Resources

Account resources is used to view, create, update, and delete the sales team members of an account. The sales team members represent a resource party, and are assigned to a sales account team. A sales account team member has a defined access role for the sales account.

Create a sales team member: Method: post
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/SalesTeamMember
Delete a sales team member: Method: delete
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/SalesTeamMember/{TeamMemberId}
Get a sales team member: Method: get
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/SalesTeamMember/{TeamMemberId}
Get all sales team members: Method: get
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/SalesTeamMember
Update a sales team member: Method: patch
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/SalesTeamMember/{TeamMemberId}

Accounts/Account Rollups

The account rollups resource is used to view, create, update, and delete an account rollup.

Get all account rollups: Method: get
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/AccountRollup
Get an account rollup: Method: get
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/AccountRollup/{OrganizationProfileId}

Accounts/Additional Identifier

The additional identifiers resource is used to view, create, update, and delete an additional identifiers such as driver's license number or passport number.

Create an additional identifier: Method: post
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/AdditionalIdentifier
Delete an additional identifier: Method: delete
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/AdditionalIdentifier/{PartyIdentifierId}
Get all additional identifiers: Method: get
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/AdditionalIdentifier
Get an additional identifier: Method: get
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/AdditionalIdentifier/{PartyIdentifierId}
Update an additional identifier: Method: patch
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/AdditionalIdentifier/{PartyIdentifierId}

Accounts/Additional Names

The additional name resource is used to view, create, update, and delete additional names associated with an account. The resource allows you to capture other names associated with an account, such as a maiden name, or a brand name.

Create an additional name: Method: post
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/AdditionalName
Delete an additional name: Method: delete
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/AdditionalName/{NameId}
Get all additional name: Method: get
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/AdditionalName
Get an additional name: Method: get
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/AdditionalName/{NameId}
Update an additional name: Method: patch
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/AdditionalName/{NameId}

Accounts/Addresses

The addresses resource is used to view, create, update, and delete addresses of an account. An address contains the detailed location information of an account.

Create an address: Method: post
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/Address
Delete an address: Method: delete
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/Address/{AddressNumber}
Get all addresses: Method: get
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/Address
Get an address: Method: get
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/Address/{AddressNumber}
Update an address: Method: patch
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/Address/{AddressNumber}

Accounts/Addresses/Address Locales

The address locales resource is used to view, create, update, and delete the local address. An address locale contains the details about a location or address in the local language.

Create an address locale: Method: post
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/Address/{AddressNumber}/child/AddressLocale
Delete an address locale: Method: delete
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/Address/{AddressNumber}/child/AddressLocale/{LocationLocaleId}
Get all address locales: Method: get
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/Address/{AddressNumber}/child/AddressLocale
Get an address locale: Method: get
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/Address/{AddressNumber}/child/AddressLocale/{LocationLocaleId}
Update an address locale: Method: patch
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/Address/{AddressNumber}/child/AddressLocale/{LocationLocaleId}

Accounts/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/accounts/{PartyNumber}/child/Address/{AddressNumber}/child/AddressPurpose
Delete an address purpose: Method: delete
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/Address/{AddressNumber}/child/AddressPurpose/{AddressPurposeId}
Get all address purposes: Method: get
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/Address/{AddressNumber}/child/AddressPurpose
Get an address purpose: Method: get
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/Address/{AddressNumber}/child/AddressPurpose/{AddressPurposeId}
Update an address purpose: Method: patch
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/Address/{AddressNumber}/child/AddressPurpose/{AddressPurposeId}

Accounts/Aux Classifications

The aux classifications resource is used to view, create, update, and delete the auxiliary classifications of the customers associated with the accounts. Auxiliary classification enable you to categorize customers into different groups, such as commercial or private.

Create a customer classification: Method: post
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/CustomerClassification
Delete a customer classification: Method: delete
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/CustomerClassification/{CodeAssignmentId}
Get a customer classification: Method: get
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/CustomerClassification/{CodeAssignmentId}
Get all customer classifications: Method: get
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/CustomerClassification
Update a customer classification: Method: patch
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/CustomerClassification/{CodeAssignmentId}

Accounts/Contact Points

The contact point resource is used to view, create, update, and delete contact points for an account. Contact points can be geographical addresses, phone numbers, e-mail IDs, URLs, messenger IDs, and so on.

Create a contact point: Method: post
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/ContactPoint
Delete a contact point: Method: delete
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/ContactPoint/{ContactPointId}
Get a contact point: Method: get
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/ContactPoint/{ContactPointId}
Get all contact points: Method: get
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/ContactPoint
Update a contact point: Method: patch
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/ContactPoint/{ContactPointId}

Accounts/Large Object (LOB) Attributes - D&B Business Report

The Dun & Bradstreet business information report.

Delete a D&B Business Report: Method: delete
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/enclosure/BusinessReport
Get a D&B Business Report: Method: get
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/enclosure/BusinessReport
Replace a D&B Business Report: Method: put
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/enclosure/BusinessReport

Accounts/Notes

The notes resource is used to view, create, update, and delete notes associated with an account. A note captures comments, information, or instructions related to an account.

Create a note: Method: post
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/Note
Delete a note: Method: delete
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/Note/{NoteId}
Get a note: Method: get
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/Note/{NoteId}
Get all notes: Method: get
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/Note
Update a note: Method: patch
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/Note/{NoteId}

Accounts/Notes/Large Object (LOB) Attributes - Note Text

This is the column which will store the actual note text.

Delete a Note Text: Method: delete
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/Note/{NoteId}/enclosure/NoteTxt
Get a Note Text: Method: get
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/Note/{NoteId}/enclosure/NoteTxt
Replace a Note Text: Method: put
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/Note/{NoteId}/enclosure/NoteTxt

Accounts/Organization Contacts

The account contacts resource is used to view, create, update, and delete an account contact. It refers to a person who functions as a contact for an account.

Create an account contact: Method: post
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/AccountContact
Delete an account contact: Method: delete
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/AccountContact/{AccountContactId}
Get all account contacts: Method: get
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/AccountContact
Get an account contact: Method: get
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/AccountContact/{AccountContactId}
Update an account contact: Method: patch
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/AccountContact/{AccountContactId}

Accounts/Primary Addresses

The primary addresses resource is used to view, create, update, and delete the primary addresses of the accounts. A primary address is the default communication address of an account.

Create a primary address: Method: post
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/PrimaryAddress
Delete a primary address: Method: delete
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/PrimaryAddress/{AddressNumber}
Get a primary address: Method: get
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/PrimaryAddress/{AddressNumber}
Get all primary addresses: Method: get
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/PrimaryAddress
Update a primary address: Method: patch
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/PrimaryAddress/{AddressNumber}

Accounts/Relationships

The relationships resource is used to view, create, and update account relationships. An account relationship is the interconnection between parties, such as between an account and the account's contact person.

Create a relationship: Method: post
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/Relationship
Delete a relationship: Method: delete
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/Relationship/{RelationshipRecId}
Get a relationship: Method: get
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/Relationship/{RelationshipRecId}
Get all relationships: Method: get
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/Relationship
Update a relationship: Method: patch
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/Relationship/{RelationshipRecId}

Accounts/Smart Actions

The smart actions resource is used to view the name, security, context object, REST operation, confirmation message, and other global properties of smart actions. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.

Get a smart action - Not Supported: Method: get
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/smartActions/{UserActionId}
Get action evaluation attributes - Not Supported: Method: post
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/smartActions/action/getActionEvaluationAttributesForResource
Get all smart actions: Method: get
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/smartActions
Get attributes - Not Supported: Method: post
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/smartActions/action/getAttributesForResource
Get entities - Not Supported: Method: post
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/smartActions/action/getEntities
Get object functions - Not Supported: Method: post
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/smartActions/action/getObjectFunctions
Process mass action - Not Supported: Method: post
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/smartActions/action/processMassAction

Accounts/Smart Actions/Smart Action REST Path Parameter Definitions

The path parameter definitions resource is used to view the REST request path parameter name-value pair definitions of a smart action. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.

Get all action URL bindings - Not Supported: Method: get
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/smartActions/{UserActionId}/child/UserActionURLBinding
Get an action URL binding - Not Supported: Method: get
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/smartActions/{UserActionId}/child/UserActionURLBinding/{URLBindingId}

Accounts/Smart Actions/Smart Action REST Payload Definitions

The payload definitions resource is used to view the REST request payload name-value pair definitions of a smart action. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.

Get all action request payload - Not Supported: Method: get
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/smartActions/{UserActionId}/child/UserActionRequestPayload
Get an action request payload - Not Supported: Method: get
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/smartActions/{UserActionId}/child/UserActionRequestPayload/{RequestPayloadId}

Accounts/Smart Actions/Smart Action User Interface Definitions

The user interface definitions resource is used to view the user interfaces associated with a smart action. Each user interface can be mapped to a client application. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.

Get all action navigations - Not Supported: Method: get
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/smartActions/{UserActionId}/child/UserActionNavigation
Get an action navigation - Not Supported: Method: get
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/smartActions/{UserActionId}/child/UserActionNavigation/{UserActionNavId}

Accounts/Source System References

The source system reference resource is used to view, create, update, and delete source systems. A source system is an external system from which you import data.

Create a source system reference: Method: post
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/SourceSystemReference
Delete a source system reference: Method: delete
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/SourceSystemReference/{SourceSystemReferenceId}
Get a source system reference: Method: get
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/SourceSystemReference/{SourceSystemReferenceId}
Get all source system references: Method: get
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/SourceSystemReference
Update a source system reference: Method: patch
Path: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/SourceSystemReference/{SourceSystemReferenceId}

Contacts

The contacts resource is used to view, create, update, and delete a contact. A contact is an individual who is a customer or a prospect, or a contact for an existing customer or a consumer, or a contact that does not yet have an established business association with a customer or a consumer.

Create a contact: Method: post
Path: /crmRestApi/resources/11.13.18.05/contacts
Delete a contact: Method: delete
Path: /crmRestApi/resources/11.13.18.05/contacts/{PartyNumber}
Find duplicates: Method: post
Path: /crmRestApi/resources/11.13.18.05/contacts/action/findDuplicates
Get a contact: Method: get
Path: /crmRestApi/resources/11.13.18.05/contacts/{PartyNumber}
Get all contacts: Method: get
Path: /crmRestApi/resources/11.13.18.05/contacts
Update a contact: Method: patch
Path: /crmRestApi/resources/11.13.18.05/contacts/{PartyNumber}

Contacts/Additional Identifiers

The additional identifiers resource is used to view, create, update, and delete an additional identifiers such as driver's license number or passport number.

Create an additional identifier: Method: post
Path: /crmRestApi/resources/11.13.18.05/contacts/{PartyNumber}/child/AdditionalIdentifier
Delete an additional identifier: Method: delete
Path: /crmRestApi/resources/11.13.18.05/contacts/{PartyNumber}/child/AdditionalIdentifier/{PartyIdentifierId}
Get all additional identifiers: Method: get
Path: /crmRestApi/resources/11.13.18.05/contacts/{PartyNumber}/child/AdditionalIdentifier
Get an additional identifier: Method: get
Path: /crmRestApi/resources/11.13.18.05/contacts/{PartyNumber}/child/AdditionalIdentifier/{PartyIdentifierId}
Update an additional identifier: Method: patch
Path: /crmRestApi/resources/11.13.18.05/contacts/{PartyNumber}/child/AdditionalIdentifier/{PartyIdentifierId}

Contacts/Additional Names

The additional name resource is used to view, create, update, and delete additional names associated with a contact. The resource allows you to capture other names associated with a contact, such as a maiden name, or a brand name.

Create an additional name: Method: post
Path: /crmRestApi/resources/11.13.18.05/contacts/{PartyNumber}/child/AdditionalName
Delete an additional name: Method: delete
Path: /crmRestApi/resources/11.13.18.05/contacts/{PartyNumber}/child/AdditionalName/{NameId}
Get all additional names: Method: get
Path: /crmRestApi/resources/11.13.18.05/contacts/{PartyNumber}/child/AdditionalName
Get an additional name: Method: get
Path: /crmRestApi/resources/11.13.18.05/contacts/{PartyNumber}/child/AdditionalName/{NameId}
Update an additional name: Method: patch
Path: /crmRestApi/resources/11.13.18.05/contacts/{PartyNumber}/child/AdditionalName/{NameId}

Contacts/Attachments

The contact picture attachments resource is used to view, create, update, or delete the contacts picture.

Get a contact's picture: Method: get
Path: /crmRestApi/resources/11.13.18.05/contacts/{PartyNumber}/child/PictureAttachment/{PictureAttachmentUniqID}
Get all contacts' pictures: Method: get
Path: /crmRestApi/resources/11.13.18.05/contacts/{PartyNumber}/child/PictureAttachment
Remove a contact's picture: Method: delete
Path: /crmRestApi/resources/11.13.18.05/contacts/{PartyNumber}/child/PictureAttachment/{PictureAttachmentUniqID}
Replace a contact's picture: Method: patch
Path: /crmRestApi/resources/11.13.18.05/contacts/{PartyNumber}/child/PictureAttachment/{PictureAttachmentUniqID}
Upload a contact's picture: Method: post
Path: /crmRestApi/resources/11.13.18.05/contacts/{PartyNumber}/child/PictureAttachment

Contacts/Attachments/Large Object (LOB) Attributes - FileContents

The contents of the attachment.

Delete a FileContents: Method: delete
Path: /crmRestApi/resources/11.13.18.05/contacts/{PartyNumber}/child/PictureAttachment/{PictureAttachmentUniqID}/enclosure/FileContents
Get a FileContents: Method: get
Path: /crmRestApi/resources/11.13.18.05/contacts/{PartyNumber}/child/PictureAttachment/{PictureAttachmentUniqID}/enclosure/FileContents
Replace a FileContents: Method: put
Path: /crmRestApi/resources/11.13.18.05/contacts/{PartyNumber}/child/PictureAttachment/{PictureAttachmentUniqID}/enclosure/FileContents

Contacts/Attachments/Large Object (LOB) Attributes - FileWebImage

Get a FileWebImage: Method: get
Path: /crmRestApi/resources/11.13.18.05/contacts/{PartyNumber}/child/PictureAttachment/{PictureAttachmentUniqID}/enclosure/FileWebImage

Contacts/Aux Classifications

The aux classifications resource is used to view, create, update, and delete the auxiliary classifications of the customers associated with the contacts. Auxiliary classification enable you to categorize customers into different groups, such as commercial or private.

Create a customer classification: Method: post
Path: /crmRestApi/resources/11.13.18.05/contacts/{PartyNumber}/child/CustomerClassification
Delete a customer classification: Method: delete
Path: /crmRestApi/resources/11.13.18.05/contacts/{PartyNumber}/child/CustomerClassification/{CodeAssignmentId}
Get a customer classification: Method: get
Path: /crmRestApi/resources/11.13.18.05/contacts/{PartyNumber}/child/CustomerClassification/{CodeAssignmentId}
Get all customer classifications: Method: get
Path: /crmRestApi/resources/11.13.18.05/contacts/{PartyNumber}/child/CustomerClassification
Update a customer classification: Method: patch
Path: /crmRestApi/resources/11.13.18.05/contacts/{PartyNumber}/child/CustomerClassification/{CodeAssignmentId}

Contacts/Contact Addresses

The contact addresses resource is used to view, create, update, and delete addresses of a contact. An address contains the detailed location information of a contact.

Create an address: Method: post
Path: /crmRestApi/resources/11.13.18.05/contacts/{PartyNumber}/child/Address
Delete an address: Method: delete
Path: /crmRestApi/resources/11.13.18.05/contacts/{PartyNumber}/child/Address/{AddressNumber}
Get all addresses: Method: get
Path: /crmRestApi/resources/11.13.18.05/contacts/{PartyNumber}/child/Address
Get an address: Method: get
Path: /crmRestApi/resources/11.13.18.05/contacts/{PartyNumber}/child/Address/{AddressNumber}
Update an address: Method: patch
Path: /crmRestApi/resources/11.13.18.05/contacts/{PartyNumber}/child/Address/{AddressNumber}

Contacts/Contact Addresses/Address Locales

The address locales resource is used to view, create, update, and delete the local address. An address locale contains the details about a location or address in the local language.

Create an address locale: Method: post
Path: /crmRestApi/resources/11.13.18.05/contacts/{PartyNumber}/child/Address/{AddressNumber}/child/AddressLocale
Delete an address locale: Method: delete
Path: /crmRestApi/resources/11.13.18.05/contacts/{PartyNumber}/child/Address/{AddressNumber}/child/AddressLocale/{LocationLocaleId}
Get all address locales: Method: get
Path: /crmRestApi/resources/11.13.18.05/contacts/{PartyNumber}/child/Address/{AddressNumber}/child/AddressLocale
Get an address locale: Method: get
Path: /crmRestApi/resources/11.13.18.05/contacts/{PartyNumber}/child/Address/{AddressNumber}/child/AddressLocale/{LocationLocaleId}
Update an address locale: Method: patch
Path: /crmRestApi/resources/11.13.18.05/contacts/{PartyNumber}/child/Address/{AddressNumber}/child/AddressLocale/{LocationLocaleId}

Contacts/Contact Addresses/Contact 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/contacts/{PartyNumber}/child/Address/{AddressNumber}/child/AddressPurpose
Delete an address purpose: Method: delete
Path: /crmRestApi/resources/11.13.18.05/contacts/{PartyNumber}/child/Address/{AddressNumber}/child/AddressPurpose/{AddressPurposeId}
Get all purposes of an address: Method: get
Path: /crmRestApi/resources/11.13.18.05/contacts/{PartyNumber}/child/Address/{AddressNumber}/child/AddressPurpose
Get an address purpose: Method: get
Path: /crmRestApi/resources/11.13.18.05/contacts/{PartyNumber}/child/Address/{AddressNumber}/child/AddressPurpose/{AddressPurposeId}
Update an address purpose: Method: patch
Path: /crmRestApi/resources/11.13.18.05/contacts/{PartyNumber}/child/Address/{AddressNumber}/child/AddressPurpose/{AddressPurposeId}

Contacts/Contact Attachments

The contact attachments resource is used to view, create, update, and delete attachments of a contact. An attachment includes additional information about a contact.

Get all attachments: Method: get
Path: /crmRestApi/resources/11.13.18.05/contacts/{PartyNumber}/child/Attachment
Get an attachment: Method: get
Path: /crmRestApi/resources/11.13.18.05/contacts/{PartyNumber}/child/Attachment/{AttachmentUniqID}
Remove an attachment: Method: delete
Path: /crmRestApi/resources/11.13.18.05/contacts/{PartyNumber}/child/Attachment/{AttachmentUniqID}
Replace an attachment: Method: patch
Path: /crmRestApi/resources/11.13.18.05/contacts/{PartyNumber}/child/Attachment/{AttachmentUniqID}
Upload an attachment: Method: post
Path: /crmRestApi/resources/11.13.18.05/contacts/{PartyNumber}/child/Attachment

Contacts/Contact Attachments/Large Object (LOB) Attributes - FileContents

The contents of the attachment.

Delete a FileContents: Method: delete
Path: /crmRestApi/resources/11.13.18.05/contacts/{PartyNumber}/child/Attachment/{AttachmentUniqID}/enclosure/FileContents
Get a FileContents: Method: get
Path: /crmRestApi/resources/11.13.18.05/contacts/{PartyNumber}/child/Attachment/{AttachmentUniqID}/enclosure/FileContents
Replace a FileContents: Method: put
Path: /crmRestApi/resources/11.13.18.05/contacts/{PartyNumber}/child/Attachment/{AttachmentUniqID}/enclosure/FileContents

Contacts/Contact Attachments/Large Object (LOB) Attributes - FileWebImage

Get a FileWebImage: Method: get
Path: /crmRestApi/resources/11.13.18.05/contacts/{PartyNumber}/child/Attachment/{AttachmentUniqID}/enclosure/FileWebImage

Contacts/Contact Points

Create a contact point: Method: post
Path: /crmRestApi/resources/11.13.18.05/contacts/{PartyNumber}/child/ContactPoint
Delete a contact point: Method: delete
Path: /crmRestApi/resources/11.13.18.05/contacts/{PartyNumber}/child/ContactPoint/{ContactPointId}
Get a contact point: Method: get
Path: /crmRestApi/resources/11.13.18.05/contacts/{PartyNumber}/child/ContactPoint/{ContactPointId}
Get all contact points: Method: get
Path: /crmRestApi/resources/11.13.18.05/contacts/{PartyNumber}/child/ContactPoint
Update a contact point: Method: patch
Path: /crmRestApi/resources/11.13.18.05/contacts/{PartyNumber}/child/ContactPoint/{ContactPointId}

Contacts/Contact Primary Addresses

The primary addresses resource is used to view, create, update, and delete the primary addresses of the contacts. A primary address is the default communication address of a contact.

Create a primary address: Method: post
Path: /crmRestApi/resources/11.13.18.05/contacts/{PartyNumber}/child/PrimaryAddress
Delete a primary address: Method: delete
Path: /crmRestApi/resources/11.13.18.05/contacts/{PartyNumber}/child/PrimaryAddress/{AddressNumber}
Get a primary address: Method: get
Path: /crmRestApi/resources/11.13.18.05/contacts/{PartyNumber}/child/PrimaryAddress/{AddressNumber}
Get all primary addresses: Method: get
Path: /crmRestApi/resources/11.13.18.05/contacts/{PartyNumber}/child/PrimaryAddress
Update a primary address: Method: patch
Path: /crmRestApi/resources/11.13.18.05/contacts/{PartyNumber}/child/PrimaryAddress/{AddressNumber}

Contacts/Contact Rollups

The contact rollups resource is used to view a contact rollup.

Get a contact rollup: Method: get
Path: /crmRestApi/resources/11.13.18.05/contacts/{PartyNumber}/child/ContactRollup/{PersonProfileId}
Get all contact rollups: Method: get
Path: /crmRestApi/resources/11.13.18.05/contacts/{PartyNumber}/child/ContactRollup

Contacts/Notes

The note resource is used to view, create, update, and delete notes associated with a contact. A note captures comments, information, or instructions related to a contact.

Create a note: Method: post
Path: /crmRestApi/resources/11.13.18.05/contacts/{PartyNumber}/child/Note
Delete a note: Method: delete
Path: /crmRestApi/resources/11.13.18.05/contacts/{PartyNumber}/child/Note/{NoteId}
Get a note: Method: get
Path: /crmRestApi/resources/11.13.18.05/contacts/{PartyNumber}/child/Note/{NoteId}
Get all notes: Method: get
Path: /crmRestApi/resources/11.13.18.05/contacts/{PartyNumber}/child/Note
Update a note: Method: patch
Path: /crmRestApi/resources/11.13.18.05/contacts/{PartyNumber}/child/Note/{NoteId}

Contacts/Notes/Large Object (LOB) Attributes - Note Text

The actual note text.

Delete a Note Text: Method: delete
Path: /crmRestApi/resources/11.13.18.05/contacts/{PartyNumber}/child/Note/{NoteId}/enclosure/NoteTxt
Get a Note Text: Method: get
Path: /crmRestApi/resources/11.13.18.05/contacts/{PartyNumber}/child/Note/{NoteId}/enclosure/NoteTxt
Replace a Note Text: Method: put
Path: /crmRestApi/resources/11.13.18.05/contacts/{PartyNumber}/child/Note/{NoteId}/enclosure/NoteTxt

Contacts/Relationships

The relationships resource is used to view, create, and update contact relationships. A contact relationship is the interconnection between parties, such as employee or board member.

Create a relationship: Method: post
Path: /crmRestApi/resources/11.13.18.05/contacts/{PartyNumber}/child/Relationship
Delete a relationship: Method: delete
Path: /crmRestApi/resources/11.13.18.05/contacts/{PartyNumber}/child/Relationship/{RelationshipRecId}
Get a relationship: Method: get
Path: /crmRestApi/resources/11.13.18.05/contacts/{PartyNumber}/child/Relationship/{RelationshipRecId}
Get all relationships: Method: get
Path: /crmRestApi/resources/11.13.18.05/contacts/{PartyNumber}/child/Relationship
Update a relationship: Method: patch
Path: /crmRestApi/resources/11.13.18.05/contacts/{PartyNumber}/child/Relationship/{RelationshipRecId}

Contacts/Sales Account Resources

Sales account resources is used to view, create, update, and delete a resource party that is assigned to a sales account team. A sales account team member has a defined access role for the sales account.

Create a sales team member: Method: post
Path: /crmRestApi/resources/11.13.18.05/contacts/{PartyNumber}/child/SalesTeamMember
Delete a sales team member: Method: delete
Path: /crmRestApi/resources/11.13.18.05/contacts/{PartyNumber}/child/SalesTeamMember/{TeamMemberId}
Get a sales team member: Method: get
Path: /crmRestApi/resources/11.13.18.05/contacts/{PartyNumber}/child/SalesTeamMember/{TeamMemberId}
Get all sales team members: Method: get
Path: /crmRestApi/resources/11.13.18.05/contacts/{PartyNumber}/child/SalesTeamMember
Update a sales team member: Method: patch
Path: /crmRestApi/resources/11.13.18.05/contacts/{PartyNumber}/child/SalesTeamMember/{TeamMemberId}

Contacts/Smart Actions

Get a smart action - Not Supported: Method: get
Path: /crmRestApi/resources/11.13.18.05/contacts/{PartyNumber}/child/smartActions/{UserActionId}
Get action evaluation attributes - Not Supported: Method: post
Path: /crmRestApi/resources/11.13.18.05/contacts/{PartyNumber}/child/smartActions/action/getActionEvaluationAttributesForResource
Get all smart actions: Method: get
Path: /crmRestApi/resources/11.13.18.05/contacts/{PartyNumber}/child/smartActions
Get attributes - Not Supported: Method: post
Path: /crmRestApi/resources/11.13.18.05/contacts/{PartyNumber}/child/smartActions/action/getAttributesForResource
Get entities - Not Supported: Method: post
Path: /crmRestApi/resources/11.13.18.05/contacts/{PartyNumber}/child/smartActions/action/getEntities
Get object functions - Not Supported: Method: post
Path: /crmRestApi/resources/11.13.18.05/contacts/{PartyNumber}/child/smartActions/action/getObjectFunctions
Process mass action - Not Supported: Method: post
Path: /crmRestApi/resources/11.13.18.05/contacts/{PartyNumber}/child/smartActions/action/processMassAction

Contacts/Smart Actions/Smart Action REST Path Parameter Definitions

Get all action URL bindings - Not Supported: Method: get
Path: /crmRestApi/resources/11.13.18.05/contacts/{PartyNumber}/child/smartActions/{UserActionId}/child/UserActionURLBinding
Get an action URL binding - Not Supported: Method: get
Path: /crmRestApi/resources/11.13.18.05/contacts/{PartyNumber}/child/smartActions/{UserActionId}/child/UserActionURLBinding/{URLBindingId}

Contacts/Smart Actions/Smart Action REST Payload Definitions

Get all action request payload - Not Supported: Method: get
Path: /crmRestApi/resources/11.13.18.05/contacts/{PartyNumber}/child/smartActions/{UserActionId}/child/UserActionRequestPayload
Get an action request payload - Not Supported: Method: get
Path: /crmRestApi/resources/11.13.18.05/contacts/{PartyNumber}/child/smartActions/{UserActionId}/child/UserActionRequestPayload/{RequestPayloadId}

Contacts/Smart Actions/Smart Action User Interface Definitions

Get all action navigations - Not Supported: Method: get
Path: /crmRestApi/resources/11.13.18.05/contacts/{PartyNumber}/child/smartActions/{UserActionId}/child/UserActionNavigation
Get an action navigation - Not Supported: Method: get
Path: /crmRestApi/resources/11.13.18.05/contacts/{PartyNumber}/child/smartActions/{UserActionId}/child/UserActionNavigation/{UserActionNavId}

Contacts/Source System References

The source system reference resource is used to view, create, update, and delete source systems. A source system is an external system from which you import data.

Create a source system reference: Method: post
Path: /crmRestApi/resources/11.13.18.05/contacts/{PartyNumber}/child/SourceSystemReference
Delete a source system reference: Method: delete
Path: /crmRestApi/resources/11.13.18.05/contacts/{PartyNumber}/child/SourceSystemReference/{SourceSystemReferenceId}
Get a source system reference: Method: get
Path: /crmRestApi/resources/11.13.18.05/contacts/{PartyNumber}/child/SourceSystemReference/{SourceSystemReferenceId}
Get all source system references: Method: get
Path: /crmRestApi/resources/11.13.18.05/contacts/{PartyNumber}/child/SourceSystemReference
Update a source system reference: Method: patch
Path: /crmRestApi/resources/11.13.18.05/contacts/{PartyNumber}/child/SourceSystemReference/{SourceSystemReferenceId}

Households

The household resource is used to view, create, update, and delete a household. A household is a party consisting of a collection of persons and organizations. A household, similar to a person or organization, can enter into a business relationship with other parties and can be assigned to opportunities and leads. A household can also have members of party type person or organization.

Create a household: Method: post
Path: /crmRestApi/resources/11.13.18.05/households
Delete a household: Method: delete
Path: /crmRestApi/resources/11.13.18.05/households/{PartyNumber}
Get a household: Method: get
Path: /crmRestApi/resources/11.13.18.05/households/{PartyNumber}
Get all households: Method: get
Path: /crmRestApi/resources/11.13.18.05/households
Update a household: Method: patch
Path: /crmRestApi/resources/11.13.18.05/households/{PartyNumber}

Households/Additional Identifiers

An object that includes attributes used to store details of additional identifiers associated to a Party. For example, if the customer would like to capture the Drivers License or the passport information for a party, this information would be stored as a Additional Identifier.

Create an additional identifier: Method: post
Path: /crmRestApi/resources/11.13.18.05/households/{PartyNumber}/child/AdditionalIdentifier
Delete an additional identifier: Method: delete
Path: /crmRestApi/resources/11.13.18.05/households/{PartyNumber}/child/AdditionalIdentifier/{PartyIdentifierId}
Get all additional identifiers: Method: get
Path: /crmRestApi/resources/11.13.18.05/households/{PartyNumber}/child/AdditionalIdentifier
Get an additional identifier: Method: get
Path: /crmRestApi/resources/11.13.18.05/households/{PartyNumber}/child/AdditionalIdentifier/{PartyIdentifierId}
Update an additional identifier: Method: patch
Path: /crmRestApi/resources/11.13.18.05/households/{PartyNumber}/child/AdditionalIdentifier/{PartyIdentifierId}

Households/Additional Names

The additional name resource is used to view, create, update, and delete additional names associated with an account. You can use the resource to capture other names associated with an account, such as a maiden name, or a brand name.

Create an additional name: Method: post
Path: /crmRestApi/resources/11.13.18.05/households/{PartyNumber}/child/AdditionalName
Delete an additional name: Method: delete
Path: /crmRestApi/resources/11.13.18.05/households/{PartyNumber}/child/AdditionalName/{NameId}
Get all additional names: Method: get
Path: /crmRestApi/resources/11.13.18.05/households/{PartyNumber}/child/AdditionalName
Get an additional name: Method: get
Path: /crmRestApi/resources/11.13.18.05/households/{PartyNumber}/child/AdditionalName/{NameId}
Update an additional name: Method: patch
Path: /crmRestApi/resources/11.13.18.05/households/{PartyNumber}/child/AdditionalName/{NameId}

Households/Addresses

The addresses resource is used to view, create, update, and delete addresses of a household. An address contains the detailed location information of a household.

Create an address: Method: post
Path: /crmRestApi/resources/11.13.18.05/households/{PartyNumber}/child/Address
Delete an address: Method: delete
Path: /crmRestApi/resources/11.13.18.05/households/{PartyNumber}/child/Address/{AddressNumber}
Get all addresses: Method: get
Path: /crmRestApi/resources/11.13.18.05/households/{PartyNumber}/child/Address
Get an address: Method: get
Path: /crmRestApi/resources/11.13.18.05/households/{PartyNumber}/child/Address/{AddressNumber}
Update an address: Method: patch
Path: /crmRestApi/resources/11.13.18.05/households/{PartyNumber}/child/Address/{AddressNumber}

Households/Addresses/Address Locales

The address locales resource is used to view, create, update, and delete the local address. An address locale contains the details about a location or address in the local language.

Create an address locale: Method: post
Path: /crmRestApi/resources/11.13.18.05/households/{PartyNumber}/child/Address/{AddressNumber}/child/AddressLocale
Delete an address locale: Method: delete
Path: /crmRestApi/resources/11.13.18.05/households/{PartyNumber}/child/Address/{AddressNumber}/child/AddressLocale/{LocationLocaleId}
Get all address locales: Method: get
Path: /crmRestApi/resources/11.13.18.05/households/{PartyNumber}/child/Address/{AddressNumber}/child/AddressLocale
Get an address locale: Method: get
Path: /crmRestApi/resources/11.13.18.05/households/{PartyNumber}/child/Address/{AddressNumber}/child/AddressLocale/{LocationLocaleId}
Update an address locale: Method: patch
Path: /crmRestApi/resources/11.13.18.05/households/{PartyNumber}/child/Address/{AddressNumber}/child/AddressLocale/{LocationLocaleId}

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}

Households/Attachments

The attachments resource is used to view, create, update, and delete attachments of a household. An attachment includes additional information about a household.

Get all attachments: Method: get
Path: /crmRestApi/resources/11.13.18.05/households/{PartyNumber}/child/Attachment
Get an attachment: Method: get
Path: /crmRestApi/resources/11.13.18.05/households/{PartyNumber}/child/Attachment/{AttachmentUniqID}
Remove an attachment: Method: delete
Path: /crmRestApi/resources/11.13.18.05/households/{PartyNumber}/child/Attachment/{AttachmentUniqID}
Replace an attachment: Method: patch
Path: /crmRestApi/resources/11.13.18.05/households/{PartyNumber}/child/Attachment/{AttachmentUniqID}
Upload an attachment: Method: post
Path: /crmRestApi/resources/11.13.18.05/households/{PartyNumber}/child/Attachment

Households/Attachments/Large Object (LOB) Attributes - FileContents

The contents of the attachment.

Delete a FileContents: Method: delete
Path: /crmRestApi/resources/11.13.18.05/households/{PartyNumber}/child/Attachment/{AttachmentUniqID}/enclosure/FileContents
Get a FileContents: Method: get
Path: /crmRestApi/resources/11.13.18.05/households/{PartyNumber}/child/Attachment/{AttachmentUniqID}/enclosure/FileContents
Replace a FileContents: Method: put
Path: /crmRestApi/resources/11.13.18.05/households/{PartyNumber}/child/Attachment/{AttachmentUniqID}/enclosure/FileContents

Households/Attachments/Large Object (LOB) Attributes - FileWebImage

Get a FileWebImage: Method: get
Path: /crmRestApi/resources/11.13.18.05/households/{PartyNumber}/child/Attachment/{AttachmentUniqID}/enclosure/FileWebImage

Households/Aux Classifications

The aux classifications resource is used to view, create, update, and delete the auxiliary classifications of the customers associated with the households. Auxiliary classification enable you to categorize customers into different groups, such as commercial or private.

Create a customer classification: Method: post
Path: /crmRestApi/resources/11.13.18.05/households/{PartyNumber}/child/CustomerClassification
Delete a customer classification: Method: delete
Path: /crmRestApi/resources/11.13.18.05/households/{PartyNumber}/child/CustomerClassification/{CodeAssignmentId}
Get a customer classification: Method: get
Path: /crmRestApi/resources/11.13.18.05/households/{PartyNumber}/child/CustomerClassification/{CodeAssignmentId}
Get all customer classifications: Method: get
Path: /crmRestApi/resources/11.13.18.05/households/{PartyNumber}/child/CustomerClassification
Update a customer classification: Method: patch
Path: /crmRestApi/resources/11.13.18.05/households/{PartyNumber}/child/CustomerClassification/{CodeAssignmentId}

Households/Contact Points

An object that includes attributes used to store values while creating or updating the contact point. The Contactpoint describes the types of contact points. For example, phone,email,web etc.

Create a contact point: Method: post
Path: /crmRestApi/resources/11.13.18.05/households/{PartyNumber}/child/ContactPoint
Delete a contact point: Method: delete
Path: /crmRestApi/resources/11.13.18.05/households/{PartyNumber}/child/ContactPoint/{ContactPointId}
Get a contact point: Method: get
Path: /crmRestApi/resources/11.13.18.05/households/{PartyNumber}/child/ContactPoint/{ContactPointId}
Get all contact points: Method: get
Path: /crmRestApi/resources/11.13.18.05/households/{PartyNumber}/child/ContactPoint
Update a contact point: Method: patch
Path: /crmRestApi/resources/11.13.18.05/households/{PartyNumber}/child/ContactPoint/{ContactPointId}

Households/Notes

The note resource is used to view, create, update, and delete notes associated with a household. A note captures comments, information, or instructions related to a household.

Create a note: Method: post
Path: /crmRestApi/resources/11.13.18.05/households/{PartyNumber}/child/Note
Delete a note: Method: delete
Path: /crmRestApi/resources/11.13.18.05/households/{PartyNumber}/child/Note/{NoteId}
Get a note: Method: get
Path: /crmRestApi/resources/11.13.18.05/households/{PartyNumber}/child/Note/{NoteId}
Get all notes: Method: get
Path: /crmRestApi/resources/11.13.18.05/households/{PartyNumber}/child/Note
Update a note: Method: patch
Path: /crmRestApi/resources/11.13.18.05/households/{PartyNumber}/child/Note/{NoteId}

Households/Notes/Large Object (LOB) Attributes - Note Text

The column which will store the actual note text.

Delete a Note Text: Method: delete
Path: /crmRestApi/resources/11.13.18.05/households/{PartyNumber}/child/Note/{NoteId}/enclosure/NoteTxt
Get a Note Text: Method: get
Path: /crmRestApi/resources/11.13.18.05/households/{PartyNumber}/child/Note/{NoteId}/enclosure/NoteTxt
Replace a Note Text: Method: put
Path: /crmRestApi/resources/11.13.18.05/households/{PartyNumber}/child/Note/{NoteId}/enclosure/NoteTxt

Households/Primary Addresses

The primary addresses resource is used to view, create, update, and delete the primary addresses of the households. A primary address is the default communication address of a household.

Create a primary address: Method: post
Path: /crmRestApi/resources/11.13.18.05/households/{PartyNumber}/child/PrimaryAddress
Delete a primary address: Method: delete
Path: /crmRestApi/resources/11.13.18.05/households/{PartyNumber}/child/PrimaryAddress/{AddressNumber}
Get a primary address: Method: get
Path: /crmRestApi/resources/11.13.18.05/households/{PartyNumber}/child/PrimaryAddress/{AddressNumber}
Get all primary addresses: Method: get
Path: /crmRestApi/resources/11.13.18.05/households/{PartyNumber}/child/PrimaryAddress
Update a primary address: Method: patch
Path: /crmRestApi/resources/11.13.18.05/households/{PartyNumber}/child/PrimaryAddress/{AddressNumber}

Households/Relationships

The relationships resource is used to view, create, and update household relationships. A household relationship is the interconnection between parties, such as employee or board member.

Create a relationship: Method: post
Path: /crmRestApi/resources/11.13.18.05/households/{PartyNumber}/child/Relationship
Delete a relationship: Method: delete
Path: /crmRestApi/resources/11.13.18.05/households/{PartyNumber}/child/Relationship/{RelationshipRecId}
Get a relationship: Method: get
Path: /crmRestApi/resources/11.13.18.05/households/{PartyNumber}/child/Relationship/{RelationshipRecId}
Get all relationships: Method: get
Path: /crmRestApi/resources/11.13.18.05/households/{PartyNumber}/child/Relationship
Update a relationship: Method: patch
Path: /crmRestApi/resources/11.13.18.05/households/{PartyNumber}/child/Relationship/{RelationshipRecId}

Households/Sales Account Resources

Create a sales team member: Method: post
Path: /crmRestApi/resources/11.13.18.05/households/{PartyNumber}/child/SalesTeamMember
Delete a sales team member: Method: delete
Path: /crmRestApi/resources/11.13.18.05/households/{PartyNumber}/child/SalesTeamMember/{TeamMemberId}
Get a sales team member: Method: get
Path: /crmRestApi/resources/11.13.18.05/households/{PartyNumber}/child/SalesTeamMember/{TeamMemberId}
Get all sales team members: Method: get
Path: /crmRestApi/resources/11.13.18.05/households/{PartyNumber}/child/SalesTeamMember
Update a sales team member: Method: patch
Path: /crmRestApi/resources/11.13.18.05/households/{PartyNumber}/child/SalesTeamMember/{TeamMemberId}

Households/Source System References

An external system from which data can be imported into the trading community registry.

Create a source system reference: Method: post
Path: /crmRestApi/resources/11.13.18.05/households/{PartyNumber}/child/SourceSystemReference
Delete a source system reference: Method: delete
Path: /crmRestApi/resources/11.13.18.05/households/{PartyNumber}/child/SourceSystemReference/{SourceSystemReferenceId}
Get a source system reference: Method: get
Path: /crmRestApi/resources/11.13.18.05/households/{PartyNumber}/child/SourceSystemReference/{SourceSystemReferenceId}
Get all source system references: Method: get
Path: /crmRestApi/resources/11.13.18.05/households/{PartyNumber}/child/SourceSystemReference
Update a source system reference: Method: patch
Path: /crmRestApi/resources/11.13.18.05/households/{PartyNumber}/child/SourceSystemReference/{SourceSystemReferenceId}

List of Values/(Deprecated) Loyalty Products

The loyalty products resource is used to retrieve details of loyalty products that are available for redemption.

Get a loyalty product detail (Deprecated): Method: get
Path: /crmRestApi/resources/11.13.18.05/loyaltyProducts/{loyaltyProductsUniqID}
Get all loyalty products (Deprecated): Method: get
Path: /crmRestApi/resources/11.13.18.05/loyaltyProducts

List of Values/(Deprecated) Loyalty Programs

The loyalty programs resource is used to retrieve the details of a loyalty program.

Get a loyalty program (Deprecated): Method: get
Path: /crmRestApi/resources/11.13.18.05/loyaltyPrograms/{LoyProgramId}
Get all loyalty programs (Deprecated): Method: get
Path: /crmRestApi/resources/11.13.18.05/loyaltyPrograms

List of Values/(Deprecated) Loyalty Programs/(Deprecated) Calendar Attributes

The loyalty programs resource is used to retrieve the details of the calendar attributes defined for the program.

Get a calendar attribute (Deprecated): Method: get
Path: /crmRestApi/resources/11.13.18.05/loyaltyPrograms/{LoyProgramId}/child/CalendarAttributes/{LoyAttrdefnBId}
Get all calendar attributes (Deprecated): Method: get
Path: /crmRestApi/resources/11.13.18.05/loyaltyPrograms/{LoyProgramId}/child/CalendarAttributes

List of Values/(Deprecated) Loyalty Programs/(Deprecated) Member Attributes

The loyalty programs resource is used to retrieve the details of the member attribuites defined for the program.

Get a member attribute (Deprecated): Method: get
Path: /crmRestApi/resources/11.13.18.05/loyaltyPrograms/{LoyProgramId}/child/MemberAttributes/{LoyAttrdefnBId}
Get all member attributes (Deprecated): Method: get
Path: /crmRestApi/resources/11.13.18.05/loyaltyPrograms/{LoyProgramId}/child/MemberAttributes

List of Values/(Deprecated) Loyalty Programs/(Deprecated) Member Field Attributes

The loyalty programs resource is used to retrieve the details of the member field attributes defined for the program.

Get a member field attribute (Deprecated): Method: get
Path: /crmRestApi/resources/11.13.18.05/loyaltyPrograms/{LoyProgramId}/child/MemberFieldAttributes/{LoyAttrdefnBId}
Get all member field attributes (Deprecated): Method: get
Path: /crmRestApi/resources/11.13.18.05/loyaltyPrograms/{LoyProgramId}/child/MemberFieldAttributes

List of Values/(Deprecated) Loyalty Programs/(Deprecated) Point SubTypes

The loyalty programs resource is used to retrieve the details of the loyalty point subtypes defined for the program.

Get a point subtype (Deprecated): Method: get
Path: /crmRestApi/resources/11.13.18.05/loyaltyPrograms/{LoyProgramId}/child/PointSubTypes/{LoyPtsubtypeId}
Get all point subtypes (Deprecated): Method: get
Path: /crmRestApi/resources/11.13.18.05/loyaltyPrograms/{LoyProgramId}/child/PointSubTypes

List of Values/(Deprecated) Loyalty Programs/(Deprecated) Point Totals Attributes

The loyalty programs resource is used to retrieve the details of the point totals attributes defined for the program.

Get a point total attribute (Deprecated): Method: get
Path: /crmRestApi/resources/11.13.18.05/loyaltyPrograms/{LoyProgramId}/child/PointTotalsAttributes/{LoyAttrdefnBId}
Get all point total attributes (Deprecated): Method: get
Path: /crmRestApi/resources/11.13.18.05/loyaltyPrograms/{LoyProgramId}/child/PointTotalsAttributes

List of Values/(Deprecated) Loyalty Programs/(Deprecated) Point Types

The loyalty programs resource is used to retrieve the details of the loyalty point types defined for the program.

Get a point type (Deprecated): Method: get
Path: /crmRestApi/resources/11.13.18.05/loyaltyPrograms/{LoyProgramId}/child/PointTypes/{LoyAttrdefnBId}
Get all point types (Deprecated): Method: get
Path: /crmRestApi/resources/11.13.18.05/loyaltyPrograms/{LoyProgramId}/child/PointTypes

List of Values/(Deprecated) Loyalty Programs/(Deprecated) Program Partners

The loyalty programs resource is used to retrieve the details of the loyalty partners defined for the program.

Get a program partner (Deprecated): Method: get
Path: /crmRestApi/resources/11.13.18.05/loyaltyPrograms/{LoyProgramId}/child/ProgramPartners/{ProgramPartnersUniqID}
Get all program partners (Deprecated): Method: get
Path: /crmRestApi/resources/11.13.18.05/loyaltyPrograms/{LoyProgramId}/child/ProgramPartners

List of Values/(Deprecated) Loyalty Programs/(Deprecated) Redemption Products

The loyalty programs resource is used to retrieve the details of the redemption products defined for the program.

Get a redepmtion product (Deprecated): Method: get
Path: /crmRestApi/resources/11.13.18.05/loyaltyPrograms/{LoyProgramId}/child/RedemptionProducts/{RedemptionProductsUniqID}
Get all redemption products (Deprecated): Method: get
Path: /crmRestApi/resources/11.13.18.05/loyaltyPrograms/{LoyProgramId}/child/RedemptionProducts

List of Values/(Deprecated) Loyalty Programs/(Deprecated) Tier Classes

The loyalty programs resource is used to retrieve the details of a tier class defined for the program.

Get a tier class (Deprecated): Method: get
Path: /crmRestApi/resources/11.13.18.05/loyaltyPrograms/{LoyProgramId}/child/TierClasses/{LoyTierClsId}
Get all tier classes (Deprecated): Method: get
Path: /crmRestApi/resources/11.13.18.05/loyaltyPrograms/{LoyProgramId}/child/TierClasses

List of Values/(Deprecated) Loyalty Programs/(Deprecated) Transaction Attributes

The loyalty programs resource is used to retrieve the details of the transaction attributes defined for the program.

Get a transaction attribute (Deprecated): Method: get
Path: /crmRestApi/resources/11.13.18.05/loyaltyPrograms/{LoyProgramId}/child/TransactionAttributes/{LoyAttrdefnBId}
Get all transaction attributes (Deprecated): Method: get
Path: /crmRestApi/resources/11.13.18.05/loyaltyPrograms/{LoyProgramId}/child/TransactionAttributes

List of Values/(Deprecated) Loyalty Promotions

The loyalty promotions resource is used to retrieve the details of a loyalty promotion.

Get a promotion (Deprecated): Method: get
Path: /crmRestApi/resources/11.13.18.05/loyaltyPromotions/{LoyPromoId}
Get all promotions (Deprecated): Method: get
Path: /crmRestApi/resources/11.13.18.05/loyaltyPromotions

List of Values/(Deprecated) Loyalty Promotions/(Deprecated) Promotion Attributes

The loyalty promotions resource is used to retrieve the details of promotion attributes defined for the promotion.

Get a promotion attribute (Deprecated): Method: get
Path: /crmRestApi/resources/11.13.18.05/loyaltyPromotions/{LoyPromoId}/child/PromotionAttributes/{LoyAttrdefnBId}
Get all promotion attributes (Deprecated): Method: get
Path: /crmRestApi/resources/11.13.18.05/loyaltyPromotions/{LoyPromoId}/child/PromotionAttributes

List of Values/Class Codes

The class codes resource is used to view classification codes for a given classification category. All responses for the class codes resource will include a response header Cache-Control. The Cache-Control header indicates the amount of time for which the results are cached in the browser. For example, Cache-Control: "private, max-age=3600" indicates that the response is cached in the browser for 1 hour (3600 seconds).

Get a classification code: Method: get
Path: /crmRestApi/resources/11.13.18.05/classCodes/{classCodesUniqID}
Get all classification codes: Method: get
Path: /crmRestApi/resources/11.13.18.05/classCodes

List of Values/Currencies

The currencies resource is used to get a list of ISO standard currencies.

Get a currency.: Method: get
Path: /crmRestApi/resources/11.13.18.05/fndCurrencies/{CurrencyCode}
Get all currencies.: Method: get
Path: /crmRestApi/resources/11.13.18.05/fndCurrencies

List of Values/Languages

The languages list of values resource is used to query the list of languages.

Get all languages: Method: get
Path: /fscmRestApi/resources/11.13.18.05/languagesLOV

List of Values/Lookups

The lookups resource is used to view standard lookup codes.

Get a lookup.: Method: get
Path: /crmRestApi/resources/11.13.18.05/fndStaticLookups/{fndStaticLookupsUniqID}
Get all lookups.: Method: get
Path: /crmRestApi/resources/11.13.18.05/fndStaticLookups

List of Values/Loy Events

The events resource is used to retrieve the details of the event defined for the program.

Get all events: Method: get
Path: /crmRestApi/resources/11.13.18.05/loyEventsLOV
Get an event: Method: get
Path: /crmRestApi/resources/11.13.18.05/loyEventsLOV/{LoyEventId}

List of Values/Loy PointTypes

The point types resource is used to retrieve the details of the loyalty point types defined for the program.

Get a point type: Method: get
Path: /crmRestApi/resources/11.13.18.05/loyPointTypesLOV/{LoyAttrdefnBId}
Get all point types: Method: get
Path: /crmRestApi/resources/11.13.18.05/loyPointTypesLOV

List of Values/Name and ID Types

The name and types resource is used to view the additional name and ID types.

Get a Name and Type: Method: get
Path: /crmRestApi/resources/11.13.18.05/nameAndIdTypes/{TypeCode}
Get All Name And Types: Method: get
Path: /crmRestApi/resources/11.13.18.05/nameAndIdTypes

List of Values/Note Types

The note types resource is used to view the note type.

Get a note type: Method: get
Path: /crmRestApi/resources/11.13.18.05/noteTypes/{MappedLookupCode}
Get all note types: Method: get
Path: /crmRestApi/resources/11.13.18.05/noteTypes

List of Values/Phone Country Codes

The country codes resource is used to get the country codes for phone numbers. All responses for the country codes resource will include a response header Cache-Control. The Cache-Control header indicates the amount of time for which the results are cached in the browser. For example, Cache-Control: "private, max-age=3600" indicates that the response is cached in the browser for 1 hour (3600 seconds).

Get a Country Code: Method: get
Path: /crmRestApi/resources/11.13.18.05/countryCodes/{PhoneCountryCodeId}
Get all Country Codes: Method: get
Path: /crmRestApi/resources/11.13.18.05/countryCodes

List of Values/Rated Currencies

The rated currencies resource is used to view details of currency codes for CRM. It gives a list of accepted values that are defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY.

Get a rated currency: Method: get
Path: /crmRestApi/resources/11.13.18.05/ratedCurrencies/{CurrencyCode}
Get all rated currencies: Method: get
Path: /crmRestApi/resources/11.13.18.05/ratedCurrencies

List of Values/Relationship Types

The relationship types resource is used to view the relationship types.

Get a relationship type: Method: get
Path: /crmRestApi/resources/11.13.18.05/relationshipTypes/{relationshipTypesUniqID}
Get all relationship types: Method: get
Path: /crmRestApi/resources/11.13.18.05/relationshipTypes

List of Values/Standard Lookups List of Values

The standard lookups list of values resource is used to query the list of values of standard lookups, which list the available codes and translated meanings. Standard lookups are defined in the standard lookups view and store lookup codes that support reference data sharing.

Get all standard lookups: Method: get
Path: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

List of Values/Territories

The territories resource is used to get a list of ISO standard territories.

Get a territory.: Method: get
Path: /crmRestApi/resources/11.13.18.05/fndTerritories/{TerritoryCode}
Get all territories.: Method: get
Path: /crmRestApi/resources/11.13.18.05/fndTerritories

Loyalty Member Promotion Enrollments

The loyalty member promotion enrollment resource is used to retrieve the promotion enrollment details for a given loyalty member.

Get a loyalty promotion to which a member is enrolled: Method: get
Path: /crmRestApi/resources/11.13.18.05/loyaltyMemberPromotionEnrollments/{LoyPromomemId}
Get all loyalty promotions to which a member is enrolled: Method: get
Path: /crmRestApi/resources/11.13.18.05/loyaltyMemberPromotionEnrollments
Set the Incentive Choice Saved: Method: post
Path: /crmRestApi/resources/11.13.18.05/loyaltyMemberPromotionEnrollments/action/setIncentiveChoiceSaved

Loyalty Members

The loyalty members resource is used to retrieve the loyalty member details for a given loyalty program.

Create a loyalty member: Method: post
Path: /crmRestApi/resources/11.13.18.05/loyMembers
Get a loyalty member: Method: get
Path: /crmRestApi/resources/11.13.18.05/loyMembers/{MemberNumber}
Get all loyalty members: Method: get
Path: /crmRestApi/resources/11.13.18.05/loyMembers
Merge members' detail: Method: post
Path: /crmRestApi/resources/11.13.18.05/loyMembers/action/mergeMembers
Update a loyalty member: Method: patch
Path: /crmRestApi/resources/11.13.18.05/loyMembers/{MemberNumber}

Loyalty Members/Activities

The activities resource is used to retrive the details of activities associted with the loyalty members.

Get all activities detail associated with a given loyalty member: Method: get
Path: /crmRestApi/resources/11.13.18.05/loyMembers/{MemberNumber}/child/activities
Get an activity detail associated with a given loyalty member: Method: get
Path: /crmRestApi/resources/11.13.18.05/loyMembers/{MemberNumber}/child/activities/{LoyTransactionId}

Loyalty Members/Cards

The cards resource is used to retrieve the details of membership cards for the given loyalty member.

Create a membership card: Method: post
Path: /crmRestApi/resources/11.13.18.05/loyMembers/{MemberNumber}/child/cards
Get a membership card for a given loyalty member: Method: get
Path: /crmRestApi/resources/11.13.18.05/loyMembers/{MemberNumber}/child/cards/{LoyCardId}
Get all membership cards for a given loyalty member: Method: get
Path: /crmRestApi/resources/11.13.18.05/loyMembers/{MemberNumber}/child/cards
Update a membership card: Method: patch
Path: /crmRestApi/resources/11.13.18.05/loyMembers/{MemberNumber}/child/cards/{LoyCardId}

Loyalty Members/Group Members

The group members resource is used to retrieve the details of a group member attribute associated with the loyalty member.

Create a group member association with a given loyalty member: Method: post
Path: /crmRestApi/resources/11.13.18.05/loyMembers/{MemberNumber}/child/groupMembers
Get a group member associated with a given loyalty member: Method: get
Path: /crmRestApi/resources/11.13.18.05/loyMembers/{MemberNumber}/child/groupMembers/{MemberAssociationId}
Get all group members associated with a given loyalty member: Method: get
Path: /crmRestApi/resources/11.13.18.05/loyMembers/{MemberNumber}/child/groupMembers
Update a group member: Method: patch
Path: /crmRestApi/resources/11.13.18.05/loyMembers/{MemberNumber}/child/groupMembers/{MemberAssociationId}

Loyalty Members/Individual Members

The individual members resource is used to retrieve the details of an individual member attribute associated with the loyalty member.

Create an individual member association with a given loyalty member: Method: post
Path: /crmRestApi/resources/11.13.18.05/loyMembers/{MemberNumber}/child/individualMembers
Get all individual members associated with a given loyalty member: Method: get
Path: /crmRestApi/resources/11.13.18.05/loyMembers/{MemberNumber}/child/individualMembers
Get an individual member associated with a given loyalty member: Method: get
Path: /crmRestApi/resources/11.13.18.05/loyMembers/{MemberNumber}/child/individualMembers/{MemberAssociationId}
Update an individual member: Method: patch
Path: /crmRestApi/resources/11.13.18.05/loyMembers/{MemberNumber}/child/individualMembers/{MemberAssociationId}

Loyalty Members/Member Attributes

The member attributes resource is used to retrieve the details of a member attribute associated with the loyalty member.

Get a member attribute: Method: get
Path: /crmRestApi/resources/11.13.18.05/loyMembers/{MemberNumber}/child/MemberAttributes/{MemberAttributesUniqID}
Get all member attributes: Method: get
Path: /crmRestApi/resources/11.13.18.05/loyMembers/{MemberNumber}/child/MemberAttributes

Loyalty Members/Member Contacts

The member contact resource is used to retrieve the details of a contact that is associated with the loyalty member.

Get a contact: Method: get
Path: /crmRestApi/resources/11.13.18.05/loyMembers/{MemberNumber}/child/MemberContact/{MemberContactUniqID}
Get all contacts: Method: get
Path: /crmRestApi/resources/11.13.18.05/loyMembers/{MemberNumber}/child/MemberContact

Loyalty Members/Member Referrals

The member referrals resource is used to retrieve the contacts that are referred by the loyalty member.

Get a member referral: Method: get
Path: /crmRestApi/resources/11.13.18.05/loyMembers/{MemberNumber}/child/MemberReferrals/{LoyMemberId}
Get all member referrals: Method: get
Path: /crmRestApi/resources/11.13.18.05/loyMembers/{MemberNumber}/child/MemberReferrals
Merge member referral detail of the merged members: Method: post
Path: /crmRestApi/resources/11.13.18.05/loyMembers/{MemberNumber}/child/MemberReferrals/action/mergeMembers

Loyalty Members/Member Tiers

The member tier resource is used to retrieve the member tier details for the loyalty member.

Get a tier detail for a given loyalty member: Method: get
Path: /crmRestApi/resources/11.13.18.05/loyMembers/{MemberNumber}/child/MemberTier/{MemTierId}
Get all tiers for a given loyalty member: Method: get
Path: /crmRestApi/resources/11.13.18.05/loyMembers/{MemberNumber}/child/MemberTier

Loyalty Members/Member Transactions

The member transactions resource is used to retrieve the details of transactions performed by the loyalty member.

Cancel a loyalty transaction: Method: post
Path: /crmRestApi/resources/11.13.18.05/loyMembers/{MemberNumber}/child/MemberTransactions/action/cancelTransaction
Get a member transaction: Method: get
Path: /crmRestApi/resources/11.13.18.05/loyMembers/{MemberNumber}/child/MemberTransactions/{LoyTransactionId}
Get all member transactions: Method: get
Path: /crmRestApi/resources/11.13.18.05/loyMembers/{MemberNumber}/child/MemberTransactions
Process a loyalty transaction: Method: post
Path: /crmRestApi/resources/11.13.18.05/loyMembers/{MemberNumber}/child/MemberTransactions/action/processTransaction

Loyalty Members/Point Balances

The point balances resource is used to retrieve the point balance detail for a loyalty member.

Get a point balance for a given loyalty member: Method: get
Path: /crmRestApi/resources/11.13.18.05/loyMembers/{MemberNumber}/child/pointbalances/{LoyAttrdefnBId}
Get all point balances for a given loyalty member: Method: get
Path: /crmRestApi/resources/11.13.18.05/loyMembers/{MemberNumber}/child/pointbalances

Loyalty Members/Point Items

The point items resource is used to retrieve the point items detail for a loyalty member.

Get a point item for a given loyalty member: Method: get
Path: /crmRestApi/resources/11.13.18.05/loyMembers/{MemberNumber}/child/pointItems/{pointItemsUniqID}
Get all point items for a given loyalty member: Method: get
Path: /crmRestApi/resources/11.13.18.05/loyMembers/{MemberNumber}/child/pointItems

Loyalty Members/Promotion Attribute Details

The promotion attribute detail resource is used to retrieve the details of a member promotion attribute associated with the loyalty member.

Get a promotion attribute: Method: get
Path: /crmRestApi/resources/11.13.18.05/loyMembers/{MemberNumber}/child/PromotionAttributeDetail/{PromotionAttributeDetailUniqID}
Get all promotion attributes: Method: get
Path: /crmRestApi/resources/11.13.18.05/loyMembers/{MemberNumber}/child/PromotionAttributeDetail

Loyalty Members/Promotions

The promotions resource is used to retrieve the details of a promotion enrolled by the loyalty member.

Create an enrolled promotion: Method: post
Path: /crmRestApi/resources/11.13.18.05/loyMembers/{MemberNumber}/child/promotions
Delete an enrolled promotion: Method: delete
Path: /crmRestApi/resources/11.13.18.05/loyMembers/{MemberNumber}/child/promotions/{LoyPromomemId}
Get all enrolled promotions for a given loyalty member: Method: get
Path: /crmRestApi/resources/11.13.18.05/loyMembers/{MemberNumber}/child/promotions
Get an enrolled promotion: Method: get
Path: /crmRestApi/resources/11.13.18.05/loyMembers/{MemberNumber}/child/promotions/{LoyPromomemId}
Save the Incentive choice options of the enrolled promotion during member merge: Method: post
Path: /crmRestApi/resources/11.13.18.05/loyMembers/{MemberNumber}/child/promotions/action/setIncentiveChoiceSaved
Update an enrolled promotion: Method: patch
Path: /crmRestApi/resources/11.13.18.05/loyMembers/{MemberNumber}/child/promotions/{LoyPromomemId}

Loyalty Members/Vouchers

The vouchers resource is used to retrieve the vouchers that are assigned to the loyalty member.

Create a voucher for a given loyalty member: Method: post
Path: /crmRestApi/resources/11.13.18.05/loyMembers/{MemberNumber}/child/vouchers
Get a voucher for a given loyalty member: Method: get
Path: /crmRestApi/resources/11.13.18.05/loyMembers/{MemberNumber}/child/vouchers/{VoucherNumber}
Get all vouchers for a given loyalty member: Method: get
Path: /crmRestApi/resources/11.13.18.05/loyMembers/{MemberNumber}/child/vouchers
Update a voucher: Method: patch
Path: /crmRestApi/resources/11.13.18.05/loyMembers/{MemberNumber}/child/vouchers/{VoucherNumber}

Loyalty Membership Cards

The loyalty membership card resource is used to retrieve the membership card details for a given loyalty member.

Create a membership card collection for a member (Deprecated - See "Create a membership card" in the Loyalty Members resource): Method: post
Path: /crmRestApi/resources/11.13.18.05/loyaltyMembershipCards
Get a loyalty membership card that is assigned to a member: Method: get
Path: /crmRestApi/resources/11.13.18.05/loyaltyMembershipCards/{CardNumber}
Get all loyalty membership cards that are assigned to a member: Method: get
Path: /crmRestApi/resources/11.13.18.05/loyaltyMembershipCards
Update a loyalty membership card that is assigned to a member (Deprecated - See "Update a membership card" in the Loyalty Members resource): Method: patch
Path: /crmRestApi/resources/11.13.18.05/loyaltyMembershipCards/{CardNumber}

Loyalty Products

The loyalty products resource is used to retrieve the details of loyalty products that are available for redemption.

Get a loyalty product detail: Method: get
Path: /crmRestApi/resources/11.13.18.05/loyProducts/{loyProductsUniqID}
Get all loyalty products: Method: get
Path: /crmRestApi/resources/11.13.18.05/loyProducts
Set the partners saved: Method: post
Path: /crmRestApi/resources/11.13.18.05/loyProducts/action/setPartnersSaved
Set the point type saved: Method: post
Path: /crmRestApi/resources/11.13.18.05/loyProducts/action/setPointTypeSaved

Loyalty Programs

The loyalty programs resource is used to retrieve the details of a loyalty program.

Get a loyalty program: Method: get
Path: /crmRestApi/resources/11.13.18.05/loyPrograms/{LoyProgramId}
Get all loyalty programs: Method: get
Path: /crmRestApi/resources/11.13.18.05/loyPrograms

Loyalty Programs/Calendar Attributes

The calendar attributes resource is used to retrieve the details of the calendar attributes defined for the program.

Get a calendar attribute: Method: get
Path: /crmRestApi/resources/11.13.18.05/loyPrograms/{LoyProgramId}/child/CalendarAttributes/{LoyAttrdefnBId}
Get all calendar attributes: Method: get
Path: /crmRestApi/resources/11.13.18.05/loyPrograms/{LoyProgramId}/child/CalendarAttributes

Loyalty Programs/Events

The events resource is used to retrieve the details of the event defined for the loyalty program.

Create a collection of all events: Method: post
Path: /crmRestApi/resources/11.13.18.05/loyPrograms/{LoyProgramId}/child/events
Delete an event: Method: delete
Path: /crmRestApi/resources/11.13.18.05/loyPrograms/{LoyProgramId}/child/events/{LoyEventId}
Get all events: Method: get
Path: /crmRestApi/resources/11.13.18.05/loyPrograms/{LoyProgramId}/child/events
Get an event: Method: get
Path: /crmRestApi/resources/11.13.18.05/loyPrograms/{LoyProgramId}/child/events/{LoyEventId}
Update an event: Method: patch
Path: /crmRestApi/resources/11.13.18.05/loyPrograms/{LoyProgramId}/child/events/{LoyEventId}

Loyalty Programs/Events/Event Transaction Attributes

The event transaction attributes resource is used to retrieve the details of the event terms defined for the event.

Create a collection of all event transaction attributes: Method: post
Path: /crmRestApi/resources/11.13.18.05/loyPrograms/{LoyProgramId}/child/events/{LoyEventId}/child/eventTransactionAttributes
Delete an event transaction attribute: Method: delete
Path: /crmRestApi/resources/11.13.18.05/loyPrograms/{LoyProgramId}/child/events/{LoyEventId}/child/eventTransactionAttributes/{EventAttrId}
Get all event transaction attributes: Method: get
Path: /crmRestApi/resources/11.13.18.05/loyPrograms/{LoyProgramId}/child/events/{LoyEventId}/child/eventTransactionAttributes
Get an event transaction attribute: Method: get
Path: /crmRestApi/resources/11.13.18.05/loyPrograms/{LoyProgramId}/child/events/{LoyEventId}/child/eventTransactionAttributes/{EventAttrId}
Update an event transaction attribute: Method: patch
Path: /crmRestApi/resources/11.13.18.05/loyPrograms/{LoyProgramId}/child/events/{LoyEventId}/child/eventTransactionAttributes/{EventAttrId}

Loyalty Programs/Member Attributes

The member attributes resource is used to retrieve the details of the member attributes defined for the program.

Get a member attribute: Method: get
Path: /crmRestApi/resources/11.13.18.05/loyPrograms/{LoyProgramId}/child/MemberAttributes/{LoyAttrdefnBId}
Get all member attributes: Method: get
Path: /crmRestApi/resources/11.13.18.05/loyPrograms/{LoyProgramId}/child/MemberAttributes

Loyalty Programs/Member Field Attributes

The member field attributes resource is used to retrieve the details of the member field attributes defined for the program.

Get a member field attribute: Method: get
Path: /crmRestApi/resources/11.13.18.05/loyPrograms/{LoyProgramId}/child/MemberFieldAttributes/{MemberFieldAttributesUniqID}
Get all member field attributes: Method: get
Path: /crmRestApi/resources/11.13.18.05/loyPrograms/{LoyProgramId}/child/MemberFieldAttributes

Loyalty Programs/Member Tier Attributes

The member tier attributes resource is used to retrieve the details of the member tier attributes defined for the loyalty program.

Get a member tier attribute: Method: get
Path: /crmRestApi/resources/11.13.18.05/loyPrograms/{LoyProgramId}/child/MemberTierAttributes/{MemberTierAttributesUniqID}
Get all member tier attributes: Method: get
Path: /crmRestApi/resources/11.13.18.05/loyPrograms/{LoyProgramId}/child/MemberTierAttributes

Loyalty Programs/Negative Points

The negative points resource is used to retrieve the details of negative points defined for the loyalty program.

Get a negative point: Method: get
Path: /crmRestApi/resources/11.13.18.05/loyPrograms/{LoyProgramId}/child/NegativePoints/{ProgNegPointId}
Get all negative points: Method: get
Path: /crmRestApi/resources/11.13.18.05/loyPrograms/{LoyProgramId}/child/NegativePoints

Loyalty Programs/Point Blocks

The point blocks resource is used to retrieve the details of the point block defined for the partner.

Create a collection of all point blocks: Method: post
Path: /crmRestApi/resources/11.13.18.05/loyPrograms/{LoyProgramId}/child/PointBlocks
Get a point block: Method: get
Path: /crmRestApi/resources/11.13.18.05/loyPrograms/{LoyProgramId}/child/PointBlocks/{ProgPointBlockId}
Get all point blocks: Method: get
Path: /crmRestApi/resources/11.13.18.05/loyPrograms/{LoyProgramId}/child/PointBlocks
Set the partners saved: Method: post
Path: /crmRestApi/resources/11.13.18.05/loyPrograms/{LoyProgramId}/child/PointBlocks/action/setPartnersSaved

Loyalty Programs/Point Subtypes

The point subtypes resource is used to retrieve the details of the loyalty point subtypes defined for the program.

Get a point subtype: Method: get
Path: /crmRestApi/resources/11.13.18.05/loyPrograms/{LoyProgramId}/child/PointSubtypes/{LoyPtsubtypeId}
Get all point subtypes: Method: get
Path: /crmRestApi/resources/11.13.18.05/loyPrograms/{LoyProgramId}/child/PointSubtypes

Loyalty Programs/Point Total Attributes

The point total attributes resource is used to retrieve the details of the point totals attributes defined for the program.

Get a point total attribute: Method: get
Path: /crmRestApi/resources/11.13.18.05/loyPrograms/{LoyProgramId}/child/PointTotalsAttributes/{PointTotalsAttributesUniqID}
Get all point total attributes: Method: get
Path: /crmRestApi/resources/11.13.18.05/loyPrograms/{LoyProgramId}/child/PointTotalsAttributes

Loyalty Programs/Point Types

The point types resource is used to retrieve the details of the loyalty point types defined for the program.

Get a point type: Method: get
Path: /crmRestApi/resources/11.13.18.05/loyPrograms/{LoyProgramId}/child/PointTypes/{LoyAttrdefnBId}
Get all point types: Method: get
Path: /crmRestApi/resources/11.13.18.05/loyPrograms/{LoyProgramId}/child/PointTypes

Loyalty Programs/Program Partners

The program partners resource is used to retrieve the details of the loyalty partners defined for the program.

Get a program partner: Method: get
Path: /crmRestApi/resources/11.13.18.05/loyPrograms/{LoyProgramId}/child/ProgramPartners/{LoyProgOrgId}
Get all program partners: Method: get
Path: /crmRestApi/resources/11.13.18.05/loyPrograms/{LoyProgramId}/child/ProgramPartners

Loyalty Programs/Program Partners/Partner Term Attributes

The partner term attributes resource is used to retrieve the details of the partner terms defined for the partner.

Create a collection of all partner terms attributes: Method: post
Path: /crmRestApi/resources/11.13.18.05/loyPrograms/{LoyProgramId}/child/ProgramPartners/{LoyProgOrgId}/child/PartnerTermsAttributes
Delete a partner terms attribute: Method: delete
Path: /crmRestApi/resources/11.13.18.05/loyPrograms/{LoyProgramId}/child/ProgramPartners/{LoyProgOrgId}/child/PartnerTermsAttributes/{ProgPartnerPnttypeId}
Get a partner terms attribute: Method: get
Path: /crmRestApi/resources/11.13.18.05/loyPrograms/{LoyProgramId}/child/ProgramPartners/{LoyProgOrgId}/child/PartnerTermsAttributes/{ProgPartnerPnttypeId}
Get all partner terms attributes: Method: get
Path: /crmRestApi/resources/11.13.18.05/loyPrograms/{LoyProgramId}/child/ProgramPartners/{LoyProgOrgId}/child/PartnerTermsAttributes
Set the program point types saved: Method: post
Path: /crmRestApi/resources/11.13.18.05/loyPrograms/{LoyProgramId}/child/ProgramPartners/{LoyProgOrgId}/child/PartnerTermsAttributes/action/setProgPointTypeSaved
Update a partner terms attribute: Method: patch
Path: /crmRestApi/resources/11.13.18.05/loyPrograms/{LoyProgramId}/child/ProgramPartners/{LoyProgOrgId}/child/PartnerTermsAttributes/{ProgPartnerPnttypeId}

Loyalty Programs/Redemption Products

The redemption products resource is used to retrieve the details of the redemption products defined for the program.

Get a redemption product: Method: get
Path: /crmRestApi/resources/11.13.18.05/loyPrograms/{LoyProgramId}/child/RedemptionProducts/{RedemptionProductsUniqID}
Get all redemption products: Method: get
Path: /crmRestApi/resources/11.13.18.05/loyPrograms/{LoyProgramId}/child/RedemptionProducts
Set the partners saved: Method: post
Path: /crmRestApi/resources/11.13.18.05/loyPrograms/{LoyProgramId}/child/RedemptionProducts/action/setPartnersSaved
Set the point type saved: Method: post
Path: /crmRestApi/resources/11.13.18.05/loyPrograms/{LoyProgramId}/child/RedemptionProducts/action/setPointTypeSaved

Loyalty Programs/Tier Classes

The tier classes resource is used to retrieve the details of a tier class defined for the program.

Get a tier class: Method: get
Path: /crmRestApi/resources/11.13.18.05/loyPrograms/{LoyProgramId}/child/TierClasses/{TierClassesUniqID}
Get all tier classes: Method: get
Path: /crmRestApi/resources/11.13.18.05/loyPrograms/{LoyProgramId}/child/TierClasses
Set the tier saved: Method: post
Path: /crmRestApi/resources/11.13.18.05/loyPrograms/{LoyProgramId}/child/TierClasses/action/setTierSaved

Loyalty Programs/Transaction Attributes

The transaction attributes resource is used to retrieve the details of the transaction attributes defined for the program.

Get a transaction attribute: Method: get
Path: /crmRestApi/resources/11.13.18.05/loyPrograms/{LoyProgramId}/child/TransactionAttributes/{TransactionAttributesUniqID}
Get all transaction attributes: Method: get
Path: /crmRestApi/resources/11.13.18.05/loyPrograms/{LoyProgramId}/child/TransactionAttributes

Loyalty Programs/Transaction Restrictions

The transaction restrictions resource is used to retrieve the details of the transaction restrictions defined for the loyalty program.

Get a transaction restriction: Method: get
Path: /crmRestApi/resources/11.13.18.05/loyPrograms/{LoyProgramId}/child/TransactionRestrictions/{TransactionRestrictionsUniqID}
Get all transaction restrictions: Method: get
Path: /crmRestApi/resources/11.13.18.05/loyPrograms/{LoyProgramId}/child/TransactionRestrictions

Loyalty Promotions

The loyalty promotions resource is used to retrieve the details of a loyalty promotion.

Get a promotion: Method: get
Path: /crmRestApi/resources/11.13.18.05/loyPromotions/{LoyPromoId}
Get all promotions: Method: get
Path: /crmRestApi/resources/11.13.18.05/loyPromotions

Loyalty Promotions/Promotion Attributes

The promotion attributes resource is used to retrieve the details of promotion attributes defined for the promotion.

Get a promotion attribute: Method: get
Path: /crmRestApi/resources/11.13.18.05/loyPromotions/{LoyPromoId}/child/PromotionAttributes/{LoyAttrdefnBId}
Get all promotion attributes: Method: get
Path: /crmRestApi/resources/11.13.18.05/loyPromotions/{LoyPromoId}/child/PromotionAttributes

Loyalty Promotions/Promotion Incentive Choices

The promotion incentive choices resource is used to retrieve the details of incentive choices defined for the promotion.

Get all Incentive choices: Method: get
Path: /crmRestApi/resources/11.13.18.05/loyPromotions/{LoyPromoId}/child/PromotionIncentiveChoices
Get an incentive choice: Method: get
Path: /crmRestApi/resources/11.13.18.05/loyPromotions/{LoyPromoId}/child/PromotionIncentiveChoices/{LoyIncentiveChoiceId}

Loyalty Transactions

The loyalty transactions resource is used to retrieve the details of a loyalty transaction.

Cancel a loyalty transaction: Method: post
Path: /crmRestApi/resources/11.13.18.05/loyTransactions/action/cancelTransaction
Create a loyalty transaction: Method: post
Path: /crmRestApi/resources/11.13.18.05/loyTransactions
Delete a loyalty transaction: Method: delete
Path: /crmRestApi/resources/11.13.18.05/loyTransactions/{LoyTransactionId}
Get a loyalty transaction: Method: get
Path: /crmRestApi/resources/11.13.18.05/loyTransactions/{LoyTransactionId}
Get all loyalty transactions: Method: get
Path: /crmRestApi/resources/11.13.18.05/loyTransactions
Process a loyalty transaction: Method: post
Path: /crmRestApi/resources/11.13.18.05/loyTransactions/action/processTransaction
Update a loyalty transaction: Method: patch
Path: /crmRestApi/resources/11.13.18.05/loyTransactions/{LoyTransactionId}

Loyalty Transactions/Accrual Items

The accrual items resource is used to retrieve the accrual items that have been updated on transaction processing.

Get a loyalty accrual item detail updated during transaction processing: Method: get
Path: /crmRestApi/resources/11.13.18.05/loyTransactions/{LoyTransactionId}/child/AccrualItems/{AccrualItemsUniqID}
Get all loyalty accrual items updated during transaction processing: Method: get
Path: /crmRestApi/resources/11.13.18.05/loyTransactions/{LoyTransactionId}/child/AccrualItems

Loyalty Transactions/Promotions

The loyalty promotions resource is used to retrieve the details of a loyalty promotion that are applied to the transaction.

Get a loyalty promotion applied to a transaction: Method: get
Path: /crmRestApi/resources/11.13.18.05/loyTransactions/{LoyTransactionId}/child/Promotions/{PromotionId}
Get all loyalty promotions applied to a transaction: Method: get
Path: /crmRestApi/resources/11.13.18.05/loyTransactions/{LoyTransactionId}/child/Promotions

Loyalty Transactions/Promotions/Promotion Attributes

The promotion attributes resource is used to retrieve the details of a promotion attribute that is updated for transaction.

Get a loyalty promotion attribute updated during transaction processing: Method: get
Path: /crmRestApi/resources/11.13.18.05/loyTransactions/{LoyTransactionId}/child/Promotions/{PromotionId}/child/PromotionAttributes/{PromotionAttributesUniqID}
Get all loyalty promotion attributes updated during transaction processing: Method: get
Path: /crmRestApi/resources/11.13.18.05/loyTransactions/{LoyTransactionId}/child/Promotions/{PromotionId}/child/PromotionAttributes

Loyalty Transactions/Redemption Items

The redemption items resource is used to retrieve the redemption items that have been updated on transaction processing.

Get a loyalty redemption item updated during transaction processing: Method: get
Path: /crmRestApi/resources/11.13.18.05/loyTransactions/{LoyTransactionId}/child/RedemptionItems/{RedemptionItemsUniqID}
Get all loyalty redemption items updated during transaction processing: Method: get
Path: /crmRestApi/resources/11.13.18.05/loyTransactions/{LoyTransactionId}/child/RedemptionItems

Loyalty Transactions/Vouchers

The transaction vouchers resource is used to retrieve the details of loyalty vouchers that are applied to the transaction.

Get a loyalty transaction voucher assigned during transaction processing: Method: get
Path: /crmRestApi/resources/11.13.18.05/loyTransactions/{LoyTransactionId}/child/Vouchers/{LoyMemVchrId}
Get all loyalty transaction vouchers assigned during transaction processing: Method: get
Path: /crmRestApi/resources/11.13.18.05/loyTransactions/{LoyTransactionId}/child/Vouchers

Loyalty Vouchers

The loyalty voucher resource is used to retrieve the details of a loyalty voucher.

Get a voucher detail: Method: get
Path: /crmRestApi/resources/11.13.18.05/loyVouchers/{VoucherNumber}
Get all voucher details: Method: get
Path: /crmRestApi/resources/11.13.18.05/loyVouchers

Partners

The partners resource is used to view, create, and update partners. A partner is an independent business that works with one or many channel organizations. A partner could engage with an organization in sales or service, as an influencer, as support, and so on. Note: The FiscalYearendMonth attribute is not supported in the Partner REST resource though it is listed for the Partner object in the App Composer.

Create a partner: Method: post
Path: /crmRestApi/resources/11.13.18.05/partners
Get a partner: Method: get
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}
Get all partners: Method: get
Path: /crmRestApi/resources/11.13.18.05/partners
Update a partner: Method: patch
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}

Partners/Addresses

The addresses resource is used to view, create, update, and delete addresses of a partner.

Create an address: Method: post
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/addresses
Delete an address: Method: delete
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/addresses/{AddressNumber}
Get all addresses: Method: get
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/addresses
Get an address: Method: get
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/addresses/{AddressNumber}
Update an address: Method: patch
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/addresses/{AddressNumber}

Partners/Assessments

The assessments resource is used to view, create, update, and delete the assessment of a partner.

Create an assessment: Method: post
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/Assessment
Delete an assessment: Method: delete
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/Assessment/{AssessmentId}
Get all assessments: Method: get
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/Assessment
Get an assessment: Method: get
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/Assessment/{AssessmentId}
Update an assessment: Method: patch
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/Assessment/{AssessmentId}

Partners/Assessments/Assessment Answer Groups

The assessment answer groups resource is used to view and update the question groups in an assessment.

Get all assessment answer groups: Method: get
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/Assessment/{AssessmentId}/child/AssessAnswerGroups
Get an assessment answer group: Method: get
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/Assessment/{AssessmentId}/child/AssessAnswerGroups/{AssessAnswerGroupId}

Partners/Assessments/Assessment Answer Groups/Assessment Answers

The assessment answers resource is used to view and update a response to a question in the question group.

Get all assessment answers: Method: get
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/Assessment/{AssessmentId}/child/AssessAnswerGroups/{AssessAnswerGroupId}/child/AssessmentAnswer
Get an assessment answer: Method: get
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/Assessment/{AssessmentId}/child/AssessAnswerGroups/{AssessAnswerGroupId}/child/AssessmentAnswer/{AnswerId}
Update an assessment answer: Method: patch
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/Assessment/{AssessmentId}/child/AssessAnswerGroups/{AssessAnswerGroupId}/child/AssessmentAnswer/{AnswerId}

Partners/Attachments

An attachments resource is used to view, create, modify or delete the partner's attachments.

Create a partner attachment: Method: post
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/attachments
Delete a partner attachment: Method: delete
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/attachments/{attachmentsUniqID}
Get a partner attachment: Method: get
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/attachments/{attachmentsUniqID}
Get all partner attachments: Method: get
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/attachments
Update a partner attachment: Method: patch
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/attachments/{attachmentsUniqID}

Partners/Attachments/Large Object (LOB) Attributes - FileContents

Delete a FileContents: Method: delete
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/attachments/{attachmentsUniqID}/enclosure/FileContents
Get a FileContents: Method: get
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/attachments/{attachmentsUniqID}/enclosure/FileContents
Replace a FileContents: Method: put
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/attachments/{attachmentsUniqID}/enclosure/FileContents

Partners/Attachments/Large Object (LOB) Attributes - FileWebImage

Get a FileWebImage: Method: get
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/attachments/{attachmentsUniqID}/enclosure/FileWebImage

Partners/Contact Points

The contact points resource is used to view, create, update, and delete the partner's contact points such as e-mail address, phone number, fax number etc. These contact points can be assiged as a public contact point for the partner. For example, a contact point created for an e-mail address can be assigned as a public e-mail address for the partner.

Create a contact point: Method: post
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/contactPoints
Delete a contact point: Method: delete
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/contactPoints/{ContactPointId}
Get a contact point: Method: get
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/contactPoints/{ContactPointId}
Get all contact points: Method: get
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/contactPoints
Update a contact point: Method: patch
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/contactPoints/{ContactPointId}

Partners/Expertises

The expertise resource is used to view, create, and delete the partner's expertise. Partner expertise indicates areas where the partner has special knowledge or skill.

Create an expertise for a partner: Method: post
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/expertises
Delete an expertise for a partner: Method: delete
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/expertises/{PartnerMultivalLovId}
Get all expertises for a partner: Method: get
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/expertises
Get an expertise for a partner: Method: get
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/expertises/{PartnerMultivalLovId}

Partners/Focus Areas

The focus areas resource is used to view, create, or delete the partner's focus areas. For example, a partner's focus area can be green servers.

Create a product specialty for a partner: Method: post
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/productSpecialities
Delete a product specialty for a partner: Method: delete
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/productSpecialities/{PartnerDimMembersId}
Get a product specialty for a partner: Method: get
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/productSpecialities/{PartnerDimMembersId}
Get all product specialties for a partner: Method: get
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/productSpecialities

Partners/Geographies

The partner geographies resource is used to view, create, delete the geographies that the partner operates in, such as US, CA, and so on.

Create a geography for a partner: Method: post
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/geographies
Delete a geography for a partner: Method: delete
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/geographies/{PartnerDimMembersId}
Get a geography for a partner: Method: get
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/geographies/{PartnerDimMembersId}
Get all geographies for a partner: Method: get
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/geographies

Partners/Industries

The industries resource is used to view, create, and delete the industries that a channel partner works with. For example, a partner's industry can be manufacturing or automotive.

Create an industry for a partner: Method: post
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/industries
Delete an industry for a partner: Method: delete
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/industries/{PartnerDimMembersId}
Get all industries for a partner: Method: get
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/industries
Get an industry for a partner: Method: get
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/industries/{PartnerDimMembersId}

Partners/Notes

The note resource is used to view, create, update, and delete notes associated with a partner. A note captures comments, information, or instructions related to a partner.

Create a note for a partner: Method: post
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/notes
Delete a note for a partner: Method: delete
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/notes/{NoteId}
Get a note for a partner: Method: get
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/notes/{NoteId}
Get all notes for a partner: Method: get
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/notes
Update a note for a partner: Method: patch
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/notes/{NoteId}

Partners/Notes/Large Object (LOB) Attributes - Note Text

The actual note text.

Delete a Note Text: Method: delete
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/notes/{NoteId}/enclosure/NoteTxt
Get a Note Text: Method: get
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/notes/{NoteId}/enclosure/NoteTxt
Replace a Note Text: Method: put
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/notes/{NoteId}/enclosure/NoteTxt

Partners/Partner Account Team Members

The partner account team members resource is used to view, create, update, and delete the team members who will work with the partner. The team members are responsible for a partner account, and have access to edit the partner account information.

Create a partner account team member for a partner: Method: post
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/accountTeamMembers
Delete a partner account team member for a partner: Method: delete
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/accountTeamMembers/{PartnerAccountResourceId}
Get a partner account team member for a partner: Method: get
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/accountTeamMembers/{PartnerAccountResourceId}
Get all partner account team members for a partner: Method: get
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/accountTeamMembers
Update a partner account team member for a partner: Method: patch
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/accountTeamMembers/{PartnerAccountResourceId}

Partners/Partner Announcements

The partner annoucements resource is used to view the partner annoucements which are relavant to the partner user based on the partner company. The partner annoucements are created by channel users and the audience is defined based on partner company or attributes of the partner company.

Get a partner announcement: Method: get
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/partnerAnnouncements/{AnnouncementId}
Get all partner announcements: Method: get
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/partnerAnnouncements

Partners/Partner Announcements/Large Object (LOB) Attributes - Description

Get a Description: Method: get
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/partnerAnnouncements/{AnnouncementId}/enclosure/Description

Partners/Partner Certifications

The partner certifications resource is used to view, create, and delete the certifications of a partner. Through certifications, partners can qualify for competencies offered by the channel organization and become eligible for higher partner levels (Gold, Silver, Bronze), increased discounts, and so on.

Create a certification for a partner: Method: post
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/certifications
Delete a certification for a partner: Method: delete
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/certifications/{PartnerMultivalLovId}
Get a certification for a partner: Method: get
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/certifications/{PartnerMultivalLovId}
Get all certifications for a partner: Method: get
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/certifications

Partners/Partner Contacts

The partner contacts resource is used to view, create, update, and delete the contacts of a partner company. For example, a partner sales rep, a partner sales manager, a partner administrator, and so on. Note: The following attributes are not supported in the Partner Contacts resource, though they are listed for the Partner object in the App Composer: ContactRole, ContactStatus, RegistrationStatus, SalesProfileStatus, RecordSet, DataCloudStatus, and TimezoneCode.

Create a partner contact: Method: post
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/contacts
Delete a partner contact: Method: delete
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/contacts/{PartyNumber}
Get a partner contact: Method: get
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/contacts/{PartyNumber}
Get all partner contacts: Method: get
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/contacts
Update a partner contact: Method: patch
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/contacts/{PartyNumber}

Partners/Partner Contacts/Attachments

The attachments resource is used to view, create, and update attachments.

Create a partner attachment: Method: post
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/contacts/{PartyNumber}/child/attachments
Delete a partner attachment: Method: delete
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/contacts/{PartyNumber}/child/attachments/{attachmentsUniqID}
Get a partner attachment: Method: get
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/contacts/{PartyNumber}/child/attachments/{attachmentsUniqID}
Get all partner attachments: Method: get
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/contacts/{PartyNumber}/child/attachments
Update a partner attachment: Method: patch
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/contacts/{PartyNumber}/child/attachments/{attachmentsUniqID}

Partners/Partner Contacts/Attachments/Large Object (LOB) Attributes - FileContents

Delete a FileContents: Method: delete
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/contacts/{PartyNumber}/child/attachments/{attachmentsUniqID}/enclosure/FileContents
Get a FileContents: Method: get
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/contacts/{PartyNumber}/child/attachments/{attachmentsUniqID}/enclosure/FileContents
Replace a FileContents: Method: put
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/contacts/{PartyNumber}/child/attachments/{attachmentsUniqID}/enclosure/FileContents

Partners/Partner Contacts/Attachments/Large Object (LOB) Attributes - FileWebImage

Get a FileWebImage: Method: get
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/contacts/{PartyNumber}/child/attachments/{attachmentsUniqID}/enclosure/FileWebImage

Partners/Partner Contacts/User Account Details

The user account details resource is used to view, create, update, and delete the user account details of a partner contact.

Create a partner contact user detail: Method: post
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/contacts/{PartyNumber}/child/userdetails
Delete a partner contact user detail: Method: delete
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/contacts/{PartyNumber}/child/userdetails/{Username}
Get a partner contact user details: Method: get
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/contacts/{PartyNumber}/child/userdetails/{Username}
Get all partner contact user details: Method: get
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/contacts/{PartyNumber}/child/userdetails
Update a partner contact user detail: Method: patch
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/contacts/{PartyNumber}/child/userdetails/{Username}

Partners/Partner Types

The partner types resource is used to view, create, and delete the type of the partner. The partner type record enables you to categorize the partner account based on the type of business the partner performs. For example, a partner can be a reseller, a distributor, a manufacturer, and so on.

Create a partner type: Method: post
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/types
Delete a partner type: Method: delete
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/types/{PartnerDimMembersId}
Get a partner type: Method: get
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/types/{PartnerDimMembersId}
Get all partner types: Method: get
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/types

Partners/Record Set Lookup

The recordset lookup resource lets you create, update and delete a recortset lookup.

Create a record set lookup: Method: post
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/RecordSetLookup
Delete a record set lookup: Method: delete
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/RecordSetLookup/{partners_RecordSetLookup_Id}
Get a record set lookup: Method: get
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/RecordSetLookup/{partners_RecordSetLookup_Id}
Get all record set lookups: Method: get
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/RecordSetLookup
Update a record set lookup: Method: patch
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/RecordSetLookup/{partners_RecordSetLookup_Id}

Partners/Smart Actions

Get a smart action - Not Supported: Method: get
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/smartActions/{UserActionId}
Get action evaluation attributes: Method: post
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/smartActions/action/getActionEvaluationAttributesForResource
Get all smart actions: Method: get
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/smartActions
Get attributes: Method: post
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/smartActions/action/getAttributesForResource
Get entities: Method: post
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/smartActions/action/getEntities
Get object functions: Method: post
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/smartActions/action/getObjectFunctions
Process mass action: Method: post
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/smartActions/action/processMassAction

Partners/Smart Actions/Smart Action REST Path Parameter Definitions

Get all action URL bindings - Not Supported: Method: get
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/smartActions/{UserActionId}/child/UserActionURLBinding
Get an action URL binding - Not Supported: Method: get
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/smartActions/{UserActionId}/child/UserActionURLBinding/{URLBindingId}

Partners/Smart Actions/Smart Action REST Payload Definitions

Get all action request payload - Not Supported: Method: get
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/smartActions/{UserActionId}/child/UserActionRequestPayload
Get an action request payload - Not Supported: Method: get
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/smartActions/{UserActionId}/child/UserActionRequestPayload/{RequestPayloadId}

Partners/Smart Actions/Smart Action User Interface Definitions

Get all action navigations - Not Supported: Method: get
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/smartActions/{UserActionId}/child/UserActionNavigation
Get an action navigation - Not Supported: Method: get
Path: /crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/smartActions/{UserActionId}/child/UserActionNavigation/{UserActionNavId}

Product Groups

The product groups resource is used to view, create, update, delete, lock, publish, and release product groups. A product group is a business object that groups related products. For example, you might create a product group named Consumer Electronics that includes all of your consumer electronics products so that customers can browse through all the products in this group in your product catalog. Locking a product group makes it inaccessible or non editable for other users while you are making some changes. Unlocking releases the lock and rolls the changes back. Publishing the product group makes the changes available to the users at runtime.

Create a product group: Method: post
Path: /crmRestApi/resources/11.13.18.05/setupSalesCatalogs
Delete a product group: Method: delete
Path: /crmRestApi/resources/11.13.18.05/setupSalesCatalogs/{ProdGroupId}
Get a product group by product group ID: Method: get
Path: /crmRestApi/resources/11.13.18.05/setupSalesCatalogs/{ProdGroupId}
Get all product groups: Method: get
Path: /crmRestApi/resources/11.13.18.05/setupSalesCatalogs
Lock a product group for editing: Method: post
Path: /crmRestApi/resources/11.13.18.05/setupSalesCatalogs/action/lockProductGroup
Publish all product groups: Method: post
Path: /crmRestApi/resources/11.13.18.05/setupSalesCatalogs/action/publishProductGroups
Release lock on a product group: Method: post
Path: /crmRestApi/resources/11.13.18.05/setupSalesCatalogs/{ProdGroupId}/action/unlockProductGroup
Update a product group: Method: patch
Path: /crmRestApi/resources/11.13.18.05/setupSalesCatalogs/{ProdGroupId}

Product Groups/Attachments

The attachments resource is used to view, create, update, and delete the attachments associated with a product group. The attachments are typically used to associate images to the product groups so that you can identify the product groups visually in browse sales catalog.

Delete an attachment on the product group: Method: delete
Path: /crmRestApi/resources/11.13.18.05/setupSalesCatalogs/{ProdGroupId}/child/ProductGroupAttachments/{ProductGroupAttachmentsUniqID}
Get all attachment for a product group: Method: get
Path: /crmRestApi/resources/11.13.18.05/setupSalesCatalogs/{ProdGroupId}/child/ProductGroupAttachments
Get an attachment: Method: get
Path: /crmRestApi/resources/11.13.18.05/setupSalesCatalogs/{ProdGroupId}/child/ProductGroupAttachments/{ProductGroupAttachmentsUniqID}
Update an attachment: Method: patch
Path: /crmRestApi/resources/11.13.18.05/setupSalesCatalogs/{ProdGroupId}/child/ProductGroupAttachments/{ProductGroupAttachmentsUniqID}
Upload an attachment to the product group: Method: post
Path: /crmRestApi/resources/11.13.18.05/setupSalesCatalogs/{ProdGroupId}/child/ProductGroupAttachments

Product Groups/Attachments/Large Object (LOB) Attributes - FileContents

The contents of the attachment.

Delete a FileContents: Method: delete
Path: /crmRestApi/resources/11.13.18.05/setupSalesCatalogs/{ProdGroupId}/child/ProductGroupAttachments/{ProductGroupAttachmentsUniqID}/enclosure/FileContents
Get a FileContents: Method: get
Path: /crmRestApi/resources/11.13.18.05/setupSalesCatalogs/{ProdGroupId}/child/ProductGroupAttachments/{ProductGroupAttachmentsUniqID}/enclosure/FileContents
Replace a FileContents: Method: put
Path: /crmRestApi/resources/11.13.18.05/setupSalesCatalogs/{ProdGroupId}/child/ProductGroupAttachments/{ProductGroupAttachmentsUniqID}/enclosure/FileContents

Product Groups/Attachments/Large Object (LOB) Attributes - FileWebImage

Get a FileWebImage: Method: get
Path: /crmRestApi/resources/11.13.18.05/setupSalesCatalogs/{ProdGroupId}/child/ProductGroupAttachments/{ProductGroupAttachmentsUniqID}/enclosure/FileWebImage

Product Groups/Filter Attributes

The filter attributes resource is used to view, create, update, and delete the filter attributes associated with a product group. Filter attributes allows a customer to sort through the products based on their preference, such as Color, Texture, and other such material properties.

Create an attribute for the product group: Method: post
Path: /crmRestApi/resources/11.13.18.05/setupSalesCatalogs/{ProdGroupId}/child/ProductGroupAttributeSetup
Delete an attribute from a product group: Method: delete
Path: /crmRestApi/resources/11.13.18.05/setupSalesCatalogs/{ProdGroupId}/child/ProductGroupAttributeSetup/{ProdGrpAttrId}
Get all attributes on a product group: Method: get
Path: /crmRestApi/resources/11.13.18.05/setupSalesCatalogs/{ProdGroupId}/child/ProductGroupAttributeSetup
Get an attribute by product group attribute ID: Method: get
Path: /crmRestApi/resources/11.13.18.05/setupSalesCatalogs/{ProdGroupId}/child/ProductGroupAttributeSetup/{ProdGrpAttrId}
Update an attribute by product group attribute ID: Method: patch
Path: /crmRestApi/resources/11.13.18.05/setupSalesCatalogs/{ProdGroupId}/child/ProductGroupAttributeSetup/{ProdGrpAttrId}

Product Groups/Filter Attributes/Filter Attribute Values

The filter attribute values resource is used to view, create, update, and delete the values of the filter attributes associated with a product group. For example, values such as Blue or Red for the color filter attribute.

Create an attribute value: Method: post
Path: /crmRestApi/resources/11.13.18.05/setupSalesCatalogs/{ProdGroupId}/child/ProductGroupAttributeSetup/{ProdGrpAttrId}/child/ProductGroupAttributeValueSetup
Delete an attribute value: Method: delete
Path: /crmRestApi/resources/11.13.18.05/setupSalesCatalogs/{ProdGroupId}/child/ProductGroupAttributeSetup/{ProdGrpAttrId}/child/ProductGroupAttributeValueSetup/{ProdGrpAtvalId}
Get all attribute values for a given attribute setup: Method: get
Path: /crmRestApi/resources/11.13.18.05/setupSalesCatalogs/{ProdGroupId}/child/ProductGroupAttributeSetup/{ProdGrpAttrId}/child/ProductGroupAttributeValueSetup
Get an attribute value by attribute ID: Method: get
Path: /crmRestApi/resources/11.13.18.05/setupSalesCatalogs/{ProdGroupId}/child/ProductGroupAttributeSetup/{ProdGrpAttrId}/child/ProductGroupAttributeValueSetup/{ProdGrpAtvalId}
Update an attribute value: Method: patch
Path: /crmRestApi/resources/11.13.18.05/setupSalesCatalogs/{ProdGroupId}/child/ProductGroupAttributeSetup/{ProdGrpAttrId}/child/ProductGroupAttributeValueSetup/{ProdGrpAtvalId}

Product Groups/Products

The products resource is used to view, create, update, and delete the product association to a product group. Typically, products are associated to the leaf most nodes of the product group hierarchy. These products are sourced from items defined in Product Information Management.

Create a product for the product group: Method: post
Path: /crmRestApi/resources/11.13.18.05/setupSalesCatalogs/{ProdGroupId}/child/ProductGroupProductSetup
Delete a product on a product group: Method: delete
Path: /crmRestApi/resources/11.13.18.05/setupSalesCatalogs/{ProdGroupId}/child/ProductGroupProductSetup/{ProdGroupItemsId}
Get a product relationship details: Method: get
Path: /crmRestApi/resources/11.13.18.05/setupSalesCatalogs/{ProdGroupId}/child/ProductGroupProductSetup/{ProdGroupItemsId}
Get all product relationships on a product group: Method: get
Path: /crmRestApi/resources/11.13.18.05/setupSalesCatalogs/{ProdGroupId}/child/ProductGroupProductSetup
Update a product relationship on a product group: Method: patch
Path: /crmRestApi/resources/11.13.18.05/setupSalesCatalogs/{ProdGroupId}/child/ProductGroupProductSetup/{ProdGroupItemsId}

Product Groups/Products/EligibilityRules

The eligibility rules resource is used to view, create, update, and delete the various eligibility rules so that only a few products are available for selection at run time. For each item, you can add one or more eligibility rules specifying whether a rule is valid for a particular country or for all countries.

Create an eligibility rule: Method: post
Path: /crmRestApi/resources/11.13.18.05/setupSalesCatalogs/{ProdGroupId}/child/ProductGroupProductSetup/{ProdGroupItemsId}/child/EligibilityRules
Delete an eligibility rule: Method: delete
Path: /crmRestApi/resources/11.13.18.05/setupSalesCatalogs/{ProdGroupId}/child/ProductGroupProductSetup/{ProdGroupItemsId}/child/EligibilityRules/{EligibilityRuleId}
Get all eligibility rules: Method: get
Path: /crmRestApi/resources/11.13.18.05/setupSalesCatalogs/{ProdGroupId}/child/ProductGroupProductSetup/{ProdGroupItemsId}/child/EligibilityRules
Get an eligibility rule: Method: get
Path: /crmRestApi/resources/11.13.18.05/setupSalesCatalogs/{ProdGroupId}/child/ProductGroupProductSetup/{ProdGroupItemsId}/child/EligibilityRules/{EligibilityRuleId}
Update an eligibility rule: Method: patch
Path: /crmRestApi/resources/11.13.18.05/setupSalesCatalogs/{ProdGroupId}/child/ProductGroupProductSetup/{ProdGroupItemsId}/child/EligibilityRules/{EligibilityRuleId}

Product Groups/Related Groups

The related groups resource is used to view, create, update, and delete the association between sub product groups and parent product groups. While the Subgroups resource can be used to create or update the product group to sub group association, the deletion of such association can only be done using the Related Groups resource.

Create a subgroup relationship: Method: post
Path: /crmRestApi/resources/11.13.18.05/setupSalesCatalogs/{ProdGroupId}/child/ProductGroupRelationSetup
Delete a subgroup relationship: Method: delete
Path: /crmRestApi/resources/11.13.18.05/setupSalesCatalogs/{ProdGroupId}/child/ProductGroupRelationSetup/{ProdGroupRelationshipId}
Get a subgroup relationship: Method: get
Path: /crmRestApi/resources/11.13.18.05/setupSalesCatalogs/{ProdGroupId}/child/ProductGroupRelationSetup/{ProdGroupRelationshipId}
Get all subgroup relationships: Method: get
Path: /crmRestApi/resources/11.13.18.05/setupSalesCatalogs/{ProdGroupId}/child/ProductGroupRelationSetup
Update a subgroup relationship: Method: patch
Path: /crmRestApi/resources/11.13.18.05/setupSalesCatalogs/{ProdGroupId}/child/ProductGroupRelationSetup/{ProdGroupRelationshipId}

Product Groups/Subgroups

The subgroups resources is used to view, create, and update the association of a sub product group to a parent product group so that a hierarchy of product groups can be built.

Create a subgroup: Method: post
Path: /crmRestApi/resources/11.13.18.05/setupSalesCatalogs/{ProdGroupId}/child/ProductGroupSubgroupAdministration
Get a subgroup details: Method: get
Path: /crmRestApi/resources/11.13.18.05/setupSalesCatalogs/{ProdGroupId}/child/ProductGroupSubgroupAdministration/{ProdGroupId2}
Get all subgroups within a product group: Method: get
Path: /crmRestApi/resources/11.13.18.05/setupSalesCatalogs/{ProdGroupId}/child/ProductGroupSubgroupAdministration
Update a subgroup: Method: patch
Path: /crmRestApi/resources/11.13.18.05/setupSalesCatalogs/{ProdGroupId}/child/ProductGroupSubgroupAdministration/{ProdGroupId2}

Products

The product resource is used to view, create, or modify a product. A product is an item that an organization or company intends to sell.

Create a product: Method: post
Path: /crmRestApi/resources/11.13.18.05/products
Get a product: Method: get
Path: /crmRestApi/resources/11.13.18.05/products/{InventoryItemId}
Get all products: Method: get
Path: /crmRestApi/resources/11.13.18.05/products
Update a product: Method: patch
Path: /crmRestApi/resources/11.13.18.05/products/{InventoryItemId}

Products/Default Prices

The default prices resource is used to view, create, update, and delete default prices for products.

Create a default price: Method: post
Path: /crmRestApi/resources/11.13.18.05/products/{InventoryItemId}/child/DefaultPrices
Delete a default price: Method: delete
Path: /crmRestApi/resources/11.13.18.05/products/{InventoryItemId}/child/DefaultPrices/{DefaultPriceId}
Get a default price: Method: get
Path: /crmRestApi/resources/11.13.18.05/products/{InventoryItemId}/child/DefaultPrices/{DefaultPriceId}
Get all default prices: Method: get
Path: /crmRestApi/resources/11.13.18.05/products/{InventoryItemId}/child/DefaultPrices
Update a default price: Method: patch
Path: /crmRestApi/resources/11.13.18.05/products/{InventoryItemId}/child/DefaultPrices/{DefaultPriceId}

Products/Large Object (LOB) Attributes - ExtendedDescriptionOne

Delete an ExtendedDescriptionOne: Method: delete
Path: /crmRestApi/resources/11.13.18.05/products/{InventoryItemId}/enclosure/ExtendedDescriptionOne
Get an ExtendedDescriptionOne: Method: get
Path: /crmRestApi/resources/11.13.18.05/products/{InventoryItemId}/enclosure/ExtendedDescriptionOne
Replace an ExtendedDescriptionOne: Method: put
Path: /crmRestApi/resources/11.13.18.05/products/{InventoryItemId}/enclosure/ExtendedDescriptionOne

Products/Large Object (LOB) Attributes - ExtendedDescriptionTwo

Delete an ExtendedDescriptionTwo: Method: delete
Path: /crmRestApi/resources/11.13.18.05/products/{InventoryItemId}/enclosure/ExtendedDescriptionTwo
Get an ExtendedDescriptionTwo: Method: get
Path: /crmRestApi/resources/11.13.18.05/products/{InventoryItemId}/enclosure/ExtendedDescriptionTwo
Replace an ExtendedDescriptionTwo: Method: put
Path: /crmRestApi/resources/11.13.18.05/products/{InventoryItemId}/enclosure/ExtendedDescriptionTwo

Products/Product Attachments

The attachment resource is used to view, create, and update attachments of a product. An attachment includes additional information about a product.

Create an attachment for a product: Method: post
Path: /crmRestApi/resources/11.13.18.05/products/{InventoryItemId}/child/ProductAttachments
Delete an attachment for a product: Method: delete
Path: /crmRestApi/resources/11.13.18.05/products/{InventoryItemId}/child/ProductAttachments/{ProductAttachmentsUniqID}
Get all attachments for a product: Method: get
Path: /crmRestApi/resources/11.13.18.05/products/{InventoryItemId}/child/ProductAttachments
Get an attachment for a product: Method: get
Path: /crmRestApi/resources/11.13.18.05/products/{InventoryItemId}/child/ProductAttachments/{ProductAttachmentsUniqID}
Update an attachment for a product: Method: patch
Path: /crmRestApi/resources/11.13.18.05/products/{InventoryItemId}/child/ProductAttachments/{ProductAttachmentsUniqID}

Products/Product Attachments/Large Object (LOB) Attributes - FileContents

The contents of the attachment.

Delete a FileContents: Method: delete
Path: /crmRestApi/resources/11.13.18.05/products/{InventoryItemId}/child/ProductAttachments/{ProductAttachmentsUniqID}/enclosure/FileContents
Get a FileContents: Method: get
Path: /crmRestApi/resources/11.13.18.05/products/{InventoryItemId}/child/ProductAttachments/{ProductAttachmentsUniqID}/enclosure/FileContents
Replace a FileContents: Method: put
Path: /crmRestApi/resources/11.13.18.05/products/{InventoryItemId}/child/ProductAttachments/{ProductAttachmentsUniqID}/enclosure/FileContents

Products/Product Attachments/Large Object (LOB) Attributes - FileWebImage

Get a FileWebImage: Method: get
Path: /crmRestApi/resources/11.13.18.05/products/{InventoryItemId}/child/ProductAttachments/{ProductAttachmentsUniqID}/enclosure/FileWebImage

Products/Product Image Attachments

The attachment resource is used to view, create, and update image attachments of a product.

Create an image attachment for a product: Method: post
Path: /crmRestApi/resources/11.13.18.05/products/{InventoryItemId}/child/ProductImageAttachments
Delete an image attachment for a product: Method: delete
Path: /crmRestApi/resources/11.13.18.05/products/{InventoryItemId}/child/ProductImageAttachments/{ProductImageAttachmentsUniqID}
Get all image attachments for a product: Method: get
Path: /crmRestApi/resources/11.13.18.05/products/{InventoryItemId}/child/ProductImageAttachments
Get an image attachment for a product: Method: get
Path: /crmRestApi/resources/11.13.18.05/products/{InventoryItemId}/child/ProductImageAttachments/{ProductImageAttachmentsUniqID}
Update an image attachment for a product: Method: patch
Path: /crmRestApi/resources/11.13.18.05/products/{InventoryItemId}/child/ProductImageAttachments/{ProductImageAttachmentsUniqID}

Products/Product Image Attachments/Large Object (LOB) Attributes - FileContents

The contents of the attachment.

Delete a FileContents: Method: delete
Path: /crmRestApi/resources/11.13.18.05/products/{InventoryItemId}/child/ProductImageAttachments/{ProductImageAttachmentsUniqID}/enclosure/FileContents
Get a FileContents: Method: get
Path: /crmRestApi/resources/11.13.18.05/products/{InventoryItemId}/child/ProductImageAttachments/{ProductImageAttachmentsUniqID}/enclosure/FileContents
Replace a FileContents: Method: put
Path: /crmRestApi/resources/11.13.18.05/products/{InventoryItemId}/child/ProductImageAttachments/{ProductImageAttachmentsUniqID}/enclosure/FileContents

Products/Product Image Attachments/Large Object (LOB) Attributes - FileWebImage

Get a FileWebImage: Method: get
Path: /crmRestApi/resources/11.13.18.05/products/{InventoryItemId}/child/ProductImageAttachments/{ProductImageAttachmentsUniqID}/enclosure/FileWebImage

Products/Product Translations

The product translations resource is used to view, create, update, and delete product translations in various installed languages for a product.

Get a product translation: Method: get
Path: /crmRestApi/resources/11.13.18.05/products/{InventoryItemId}/child/ProductTranslations/{ProductTranslationsUniqID}
Get all product translations: Method: get
Path: /crmRestApi/resources/11.13.18.05/products/{InventoryItemId}/child/ProductTranslations

Products/Product Translations/Large Object (LOB) Attributes - ExtendedDescriptionOne

Delete an ExtendedDescriptionOne: Method: delete
Path: /crmRestApi/resources/11.13.18.05/products/{InventoryItemId}/child/ProductTranslations/{ProductTranslationsUniqID}/enclosure/ExtendedDescriptionOne
Get an ExtendedDescriptionOne: Method: get
Path: /crmRestApi/resources/11.13.18.05/products/{InventoryItemId}/child/ProductTranslations/{ProductTranslationsUniqID}/enclosure/ExtendedDescriptionOne
Replace an ExtendedDescriptionOne: Method: put
Path: /crmRestApi/resources/11.13.18.05/products/{InventoryItemId}/child/ProductTranslations/{ProductTranslationsUniqID}/enclosure/ExtendedDescriptionOne

Products/Product Translations/Large Object (LOB) Attributes - ExtendedDescriptionTwo

Delete an ExtendedDescriptionTwo: Method: delete
Path: /crmRestApi/resources/11.13.18.05/products/{InventoryItemId}/child/ProductTranslations/{ProductTranslationsUniqID}/enclosure/ExtendedDescriptionTwo
Get an ExtendedDescriptionTwo: Method: get
Path: /crmRestApi/resources/11.13.18.05/products/{InventoryItemId}/child/ProductTranslations/{ProductTranslationsUniqID}/enclosure/ExtendedDescriptionTwo
Replace an ExtendedDescriptionTwo: Method: put
Path: /crmRestApi/resources/11.13.18.05/products/{InventoryItemId}/child/ProductTranslations/{ProductTranslationsUniqID}/enclosure/ExtendedDescriptionTwo

Resources

Resources is used to view the details of a resource. A resource is a person within the deploying company who can be assigned work to accomplish business objectives, such as sales persons or partner members.

Get a resource: Method: get
Path: /crmRestApi/resources/11.13.18.05/resources/{PartyNumber}
Get all resources: Method: get
Path: /crmRestApi/resources/11.13.18.05/resources

Resources/Picture Attachments

The picture attachments resource is used to view the picture of a resource.

Get a resource's picture: Method: get
Path: /crmRestApi/resources/11.13.18.05/resources/{PartyNumber}/child/PictureAttachment/{PictureAttachmentUniqID}
Get all resources' pictures: Method: get
Path: /crmRestApi/resources/11.13.18.05/resources/{PartyNumber}/child/PictureAttachment

Resources/Picture Attachments/Large Object (LOB) Attributes - FileContents

The contents of the attachment.

Delete a FileContents: Method: delete
Path: /crmRestApi/resources/11.13.18.05/resources/{PartyNumber}/child/PictureAttachment/{PictureAttachmentUniqID}/enclosure/FileContents
Get a FileContents: Method: get
Path: /crmRestApi/resources/11.13.18.05/resources/{PartyNumber}/child/PictureAttachment/{PictureAttachmentUniqID}/enclosure/FileContents
Replace a FileContents: Method: put
Path: /crmRestApi/resources/11.13.18.05/resources/{PartyNumber}/child/PictureAttachment/{PictureAttachmentUniqID}/enclosure/FileContents

Resources/Picture Attachments/Large Object (LOB) Attributes - FileWebImage

Get a FileWebImage: Method: get
Path: /crmRestApi/resources/11.13.18.05/resources/{PartyNumber}/child/PictureAttachment/{PictureAttachmentUniqID}/enclosure/FileWebImage