日本語のコンテンツは機械翻訳されており、補助的な参照を目的としています。機械翻訳の精度は保証できません。英語版が正となります。また、現時点では検索機能は日本語での検索をサポートしていません。翻訳に関するフィードバックについては、docs@zuora.comに送信してください。

US Data Center Customers: The SOAP API is no longer under active development. The legacy SOAP calls still function, but are now also available in REST.
EU Data Center Customers: The SOAP API is not available. Please use the REST API.
APAC Data Center Customers: The SOAP API is not available. Please use the REST API.
Going forward, new features will only be available through the REST API. We strongly recommend that all integrations are done using the REST API.
You can find the REST API documentation at https://www.zuora.com/developer/.

Communication Profile

Last updated

Oct 21, 2024
Save as PDF

A communication profile is a set of policies that determine how to communicate with the contacts associated with a particular account. You must use the web-based UI to specify these policies. You can use the Zuora API to query the CommunicationProfile object, which is read-only. See Communication profiles for more information.

WSDL version 30.0+ is required to use this object.

Supported Calls

You can use this object with the following call:

query()

Field Descriptions

All field names are case sensitive. Check enumerated values in descriptions to confirm capitalization and spacing. See Field Types for additional information.

Name	Required to Create?	Allowed Operations	Description
CreatedById	optional	Query Filter	The ID of the Zuora user who created the communication profile in the web-based UI. Type: zns:ID Character limit: 32 Version notes: WSDL 30.0 Values: automatically generated
CreatedDate	optional	Query Filter	The date when the communication profile was created in the web-based UI. Type: dateTime Character limit: Version notes: WSDL 30.0 Values: automatically generated
Description	optional	Query Filter	A description of the communication profile created in the web-based UI. Type: string Character limit: Version notes: WSDL 30.0 Values:
Id	optional	Query Filter	The ID of this object. Upon creation of this object, this field becomes CommunicationProfileId. Type: zns:ID Character limit: 32 Version notes: -- Values: automatically generated
ProfileName	required	Query Filter	The name of the communication profile created in the web-based UI. Type: string Character limit: Version notes: WSDL 30.0 Values:
UpdatedById	optional	Query Filter	The ID of the Zuora user who last updated the communication profile in the web-based UI. Type: zns:ID Character limit: 32 Version notes: WSDL 30.0 Values: automatically generated
UpdatedDate	optional	Query Filter	The date when the communication profile was last updated in the web-based UI. Type: dateTime Character limit: Version notes: WSDL 30.0 Values: automatically generated

Additional Field Detail

Id

The ID of this object. Every object has a unique identifier that Zuora automatically assigns upon creation. You use this ID later when you work with the object. For example, if you send an amend() call to modify an existing subscription, then you need to include the specific Subscriptionobject's ID with the call.

The ID for the CommunicationProfile object is CommunicationProfileId.