WEBEmailUpdate

Initial Build	2008.01
xWeb	Web Method
Response Type	Boolean

This method can be used to update an existing e-mail address for a customer. To get a list of a customer's email addresses, call WEBEmailGetEmailsByCustomer. To get more information about a particular email address, call WEBEmailGet.

Parameters

The request contains the following required parameter:

Name	Type	Occurs	Description
oFacadeObject	EmailType	0(R)..1	The Email to update.

Response

Boolean. If the update is successful, the return value will be true. A failure will case a soap exception.

Sample Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns="http://www.avectra.com/2005/">
<soapenv:Header>
<ns:AuthorizationToken>
<ns:Token>*************************</ns:Token>
</ns:AuthorizationToken>
</soapenv:Header>
<soapenv:Body>
<ns:WEBEmailUpdate>
<ns:oFacadeObject>
<ns:CurrentKey>13ddadb1-bb74-4e76-88ad-b15673f02522</ns:CurrentKey>
<ns:Email>
<ns:eml_address>[e-mail]</ns:eml_address>
<ns:eml_primary>1</ns:eml_primary>
</ns:Email>
</ns:oFacadeObject>
</ns:WEBEmailUpdate>
</soapenv:Body>
</soapenv:Envelope>

Sample Response

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<soap:Header>
<AuthorizationToken xmlns="http://www.avectra.com/2005/">
<Token>2bc0f0e8-eaba-456a-9f3b-360346b32d6e</Token>
</AuthorizationToken>
</soap:Header>
<soap:Body>
<WEBEmailUpdateResponse xmlns="http://www.avectra.com/2005/">
<WEBEmailUpdateResult>true</WEBEmailUpdateResult>
</WEBEmailUpdateResponse>
</soap:Body>
</soap:Envelope>

 

JSON Method

Update the email address record for a customer.

See result from WEBEmailGet for all possible fields in the update call.

GET

POST /xweb/JSON/WEBEmailUpdate

EXAMPLE: Update the fax type and the number
DATA: JSON'
{
    "WEBEmailUpdate": {
            "oFacadeObject": {
                "CurrentKey": "76578e32-e245-4759-95fd-f3a174b28106",
                "Email": {
                    "eml_key": "76578e32-e245-4759-95fd-f3a174b28106",
                    "eml_type": "personal",
                    "eml_primary": "0"
                }
           }
      }
}

SAMPLE RESULT
HTTP STATUS: 200
DATA: JSON
true