API REFERENCE GUIDE

EMAIL SERVICES  message_update

api description

purpose

message_update updates the various fields (see optional parameters) of a message defined by its identifier mid.

message_update requires valid session parameters: uuid, usid, udid and eost. See signin for further details.

http method: POST

call cost: 1 point

See the pricing section for more details.

mandatory parameter(s)

parameter values / comments
api"message_update"
key E.g. "c54e7837e0cd0ced286cb5995327d1ab54e35987179b2". It is an application key generated by AuverCloud Studio.
uuidUnique User ID.
usidUnique Session ID.
udidUnique Device ID.
eostEnd of Session Time.
midMessage ID.

optional parameters(s)

parameter values / comments
languageOne of the AuverCloud supported languages: "en" or "fr". Used for message sending to localize on behalh of.
recipientRecipient list must be a string composed of valid email addresses separated by blank spaces.
subjectMessage subject (Max. 80 characters).
contentMessage content (Max. 4,000 characters). Text and HTML content are supported.

call sample

This example is the code used in the test case below. It assumes that jQuery and the JavaScript AuverCloud runtime client are loaded in order to use the arc.api() method. See the API client section for more details.


							

errors

code message comments
658 Unknown message ID. The message ID is not recognized.
662 Wrong email address(es) Email address bad syntax is rejected.
664 Email addresses > 10 Limitation to prevent use as emailing API

See also the Common errors section.

test bed

Call

To test the API with your own keys, please see the section Application keys in AuverCloud Studio.

api
message_read
key
mid
recipient
subject
content
 send
request
 clear
response
Response
code
msg
data

discussion