Cloud Fax and Notifications Account API 2.5 - CustomerCreate

Cloud Fax and Notifications Account API 2.5 Documentation
CustomerCreate

Cloud Fax and Notifications API Forums Home

prev next Table of Contents CustomerCreate

These pages describe an earlier version of the Cloud Fax and Notifications API.
While that version continues to function, new development should use the current version.

7.2 CustomerCreateRequest

CustomerCreate Overview CustomerCreateResult

Tag Name & type				#	Description
CustomerCreateRequest					Namespace of this element is http://ws.easylink.com/CustomerCreate/2011/01
	SubmitId xs:string			0-1	Optional string identifying request, which will be echoed in result.
	CustomerName EncodableStringType			1	Name of the customer. See EncodableStringType.
	OEMAccountNo xs:string			0-1	An optional, external account identifier provided by the creator of the account.
	ModelCustomer xs:long			1	CAN of the model customer. Many profile and account settings are copied from the model customer. The values that can be used by any given requester for this need to be set up by prior arrangement with EasyLink.
	SalesRep EncodableStringType			0-1	Sales representative of the customer. See EncodableStringType, although this value should be a numeric code. This value will normally be taken from the ModelCustomer if not provided. Allowed values vary with domain and account circumstances, and need to be determined with EasyLink.
	DealerId EncodableStringType			0-1	Dealer id of the customer. See EncodableStringType, although this value should be a numeric code. This value will normally be taken from the ModelCustomer if not provided. Allowed values vary with domain and account circumstances, and possibly the SalesRep value, and need to be determined with EasyLink.
	SupportRep EncodableStringType			0-1	Support representative of the customer. See EncodableStringType, although this value should be a numeric code. This value will normally be taken from the ModelCustomer if not provided. Allowed values vary with domain and account circumstances, and need to be determined with EasyLink.
	CustomerAddress AcctAddressType			1	Address of the customer. See AcctAddressType.
	CustomerContact AcctContactType			1	Contact details of the customer. See AcctContactType. The ContactPhone child element is required.
	AdminContact AcctContactType			0-1	Admin contact details of the customer. See AcctContactType. Only applies to, and is required for, regular account.
	AdminFax xs:string			0-1	Admin fax number of the customer.
	CustomerBillingAddress AcctAddressType			0-1	Billing address of the customer. See AcctAddressType. Defaults to CustomerAddress.
	CustomerBillingContact AcctContactType			0-1	Billing contact details of the customer. See AcctContactType. Defaults to CustomerContact. If this element is present, the ContactPhone child element is required.
	CustomerAccountStatus AcctServiceStatusType			0-1	Account status of the customer. The legal values are: active cancelled suspended inactive deleted pending hold This field is currently ignored - the UserAccountStatus is used instead.
	XDDSDomain xs:string			0-1	Primary EasyLink switch domain. For a regular account, this will default to the effective requester's primary XDDS domain.
	AltXDDSDomain xs:string			0-1	Alternate EasyLink switch domain.
	MRDomain xs:string			0-1	Primary EasyLink messageREACH domain. Only applies to regular accounts, with default taken from ModelCustomer.
	AltMRDomain xs:string			0-1	Alternate EasyLink messageREACH domain. Only applies to regular accounts, with default taken from ModelCustomer.
	AccessGroup xs:string			0-1	Access group of the customer. Controls the domains in which the user is considered valid.
	Application xs:int			0-1	Code for the application associated with the account. The default is "0". Contact EasyLink for acceptable and appropriate values.
	Business xs:int			0-1	Code for the customer business type. The default is "99". Contact EasyLink for acceptable and approparite values.
	Currency xs:int			0-1	Code for currency type. The default is taken from the ModelCustomer.
	PromoCode xs:string			0-1	Promotion code for the account. For regular accounts, the default is taken from the ModelCustomer.
	QuotaInfo QuotaInfoType			0-1	Quota information of the customer. See QuotaInfoType. Note that a "list" type for QuotaNotifyAddress is not allowed at account creation.
	ProfileInfo			0-1	A provision for future setting of customer-level profile elements at account creation time. Currently not available. The ProfileUpdate function may be used for this purpose once the account has been created.
		ProfileItem ProfileItemType		1-	See ProfileItemType.
	CustomerExtensions ExtensionType			0-1	Customer extensions. This element may be used to permit access to customer options not otherwise accessible through the Cloud Fax and Notifications API schema. See ExtensionType. No CustomerExtensions properties are currently recognized.
	InitialUserInfo			1	Contains information for the initial user set up for this customer account. An initial user is always created for a new customer account.
		UserId xs:string		0-1	The externally known user id. A UserId may contain up to 15 ASCII alphanumeric characters, '.', '/, '#, and '_'. (Note especially that a UserId may not contain spaces.) A UserId is required when creating a regular account.
		Password xs:string		0-1	Password for the initial user. Optional, but a Password will be fabricated for a regular account.
		SecurityInfo SecurityInfoType		0-1	See SecurityInfoType.
		UserName EncodableStringType		1	Name of the user.
		UserAccountStatus AcctServiceStatusType		0-1	Specifies the initial status of the user account. This defaults to "active", but may also be set to "cancelled", "suspended", "inactive", "deleted", "pending", or "hold".
		UserAddress AcctAddressType		1	Address for the user account. See AcctAddressType.
		UserContact AcctContactType		1	Contact information for user. See AcctContactType. The ContactPhone field is required in UserContact.
		TechnicalAddress AcctAddressType		0-1	An address to be used for technical issues. For regular accounts, this defaults to the UserAddress. See AcctAddressType.
		TechnicalContact AcctContactType		0-1	A contact to be used for technical issues. For regular accounts, this defaults to the UserContact. If TechnicalContact is present, then the ContactPhone child element is required. See AcctContactType.
		ShippingAddress AcctAddressType		0-1	User's shipping address. For regular accounts, this defaults to the UserAddress. See AcctAddressType.
		Mbox xs:boolean		0-1	Indicates whether or not the user will have an XDDS "mailbox".
		ReportAddress DestinationType		0-1	The address to be used for EasyLink delivery reports. See DestinationType. Note that a "list" type for ReportAddress is not allowed at account creation. Required for a regular account.
		ProfileInfo		0-1	Profile fields may be set for the initial user at account creation time. See ProfileItemType. Note that some profile fields may be set based on other information in the request, and an attempt to set them again using this element may result in request failure. The fields that should be avoided include: admin_type admin_to mailbox_user forwarding_address After account creation, profile fields can be set using the ProfileUpdate function.
			ProfileItem ProfileItemType	1-	See ProfileItemType.
		UserExtensions ExtensionType		0-1	See ExtensionType. No extension fields are currently defined.

prev next Table of Contents CustomerCreate

This information is subject to change. Please check frequently for updates.
Modified October 06, 2020