--- schema_version: "1" id: d8e7e56d3f2c6f593fa2967ac89146882324b8fcd3fd4de0eff59f2e5afe898e title: ParticipatingCustomers Class collection: legacydeveloper version: current locale: en-us portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/retail_api/TPM_ParticipatingCustomers.md canonical_url: https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/TPM_ParticipatingCustomers.htm source_site: developer.salesforce.com content_type: documentation content_hash: d247babb74464267b7b1ec688c76d95a7ca64f511c25279709f93ded1f992b32 description: This APEX class provides programmatic access to the TPM Promotion Participating Customers List used in the Promotion Push process.Serializes the information of the participating customers to a generic Object instance. Useful for using the information in Remote calls.Adds a new Participating Customer to the instance. The input parameters are the external id of the Account records and a boolean parameter to determine if the participating customer is included or excluded.Adds a new Participating Customer to the instance. The input parameters are the external id of the Account records and a boolean parameter to determine if the participating customer is included or excluded.Removes the passed in participating customer from the instance. If the participating customers is not contained in the instance, nothing is removed.Serializes the information of the participating customers information for storage.Creates an empty structure with no participating customers.Deserializes the information of the participating customers from the input generic object. The current instance will be cleared and the participating customers represented by the input will be loaded.Deserializes the information of the participating customers from the input payload. The current instance will be cleared and the participating customers represented by the payload will be loaded.Removes all information about all participating customers for the current instance. --- # ParticipatingCustomers Class This APEX class provides programmatic access to the TPM Promotion Participating Customers List used in the Promotion Push process. ## Namespace cgcloud - **[TPM\_ParticipatingCustomers Methods](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/TPM_ParticipatingCustomers.htm#tpm_participating_customers)** ## TPM\_ParticipatingCustomers Methods The following are methods for TPM\_ParticipatingCustomers. - **[global Object toGenericObject](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/TPM_ParticipatingCustomers.htm#object_data_global)** Serializes the information of the participating customers to a generic Object instance. Useful for using the information in Remote calls. - **[global ParticipatingCustomer addParticipatingCustomer](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/TPM_ParticipatingCustomers.htm#global_participation)** Adds a new Participating Customer to the instance. The input parameters are the external id of the Account records and a boolean parameter to determine if the participating customer is included or excluded. - **[global List getParticipatingCustomers](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/TPM_ParticipatingCustomers.htm#global_participation_2)** Adds a new Participating Customer to the instance. The input parameters are the external id of the Account records and a boolean parameter to determine if the participating customer is included or excluded. - **[global void removeParticipatingCustomer](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/TPM_ParticipatingCustomers.htm#global_participation_3)** Removes the passed in participating customer from the instance. If the participating customers is not contained in the instance, nothing is removed. - **[global String toJSON](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/TPM_ParticipatingCustomers.htm#object_data_json)** Serializes the information of the participating customers information for storage. - **[global TPM\_ParticipatingCustomers](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/TPM_ParticipatingCustomers.htm#global_TPM_Participating)** Creates an empty structure with no participating customers. - **[global TPM\_ParticipatingCustomers load](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/TPM_ParticipatingCustomers.htm#object_data)** Deserializes the information of the participating customers from the input generic object. The current instance will be cleared and the participating customers represented by the input will be loaded. - **[global TPM\_ParticipatingCustomers load](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/TPM_ParticipatingCustomers.htm#string_payload)** Deserializes the information of the participating customers from the input payload. The current instance will be cleared and the participating customers represented by the payload will be loaded. - **[global void clear](https://developer.salesforce.com/docs/atlas.en-us.retail_api.meta/retail_api/TPM_ParticipatingCustomers.htm#global_void_clear)** Removes all information about all participating customers for the current instance. ### global Object toGenericObject Serializes the information of the participating customers to a generic Object instance. Useful for using the information in Remote calls. #### API Version 55 #### Signature global Object toGenericObject() ### global ParticipatingCustomer addParticipatingCustomer Adds a new Participating Customer to the instance. The input parameters are the external id of the Account records and a boolean parameter to determine if the participating customer is included or excluded. #### API Version 55 #### Signature global ParticipatingCustomer addParticipatingCustomer(String externalid, Boolean included) ### global List getParticipatingCustomers Adds a new Participating Customer to the instance. The input parameters are the external id of the Account records and a boolean parameter to determine if the participating customer is included or excluded. #### API Version 55 #### Signature global List getParticipatingCustomers() ### global void removeParticipatingCustomer Removes the passed in participating customer from the instance. If the participating customers is not contained in the instance, nothing is removed. #### API Version 55 #### Signature global void removeParticipatingCustomer(ParticipatingCustomer sa) ### global String toJSON Serializes the information of the participating customers information for storage. #### API Version 55 #### Signature global String toJSON() ### global TPM\_ParticipatingCustomers Creates an empty structure with no participating customers. #### API Version 55 #### Signature global TPM\_ParticipatingCustomers() ### global TPM\_ParticipatingCustomers load Deserializes the information of the participating customers from the input generic object. The current instance will be cleared and the participating customers represented by the input will be loaded. #### API Version 55 #### Signature global TPM\_ParticipatingCustomers load(Object data) ### global TPM\_ParticipatingCustomers load Deserializes the information of the participating customers from the input payload. The current instance will be cleared and the participating customers represented by the payload will be loaded. #### API Version 55 #### Signature global TPM\_ParticipatingCustomers load(String payload) ### global void clear Removes all information about all participating customers for the current instance. #### API Version 55 #### Signature global void clear()