Knowledge Center

Knowledge Center > API > SOAP API > SOAP API Object Reference > Communication Profile

Communication Profile

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 Set Up Profiles, Notifications, and Templates for more information about communication profiles.

WSDL version 30.0+ is required to use this object.

Supported Calls

You can use this object with the following call:

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.

Last modified
17:59, 6 Oct 2015

Tags

Classifications

(not set)