API REFERENCE GUIDE

user subscription  contact

api description

purpose

contact is designed to be integrated in a contact page in order to transmit a message from a visitor to a business contact.

In addition, if the visitor provides a valid email address, then he/she will receive an acknowledgement email and will be registered as an unconfirmed subscriber.

An unconfirmed subscriber may subscribe later on as any new user, but meanwhile he/she will be able to receive emailings sent from AuverCloud Studio.

http method: POST

call cost: 1 point

See the pricing section for more details.

mandatory parameter(s)

parameter values / comments
api"contact"
key E.g. "c54e7837e0cd0ced286cb5995327d1ab54e35987179b2". It is an application key generated by AuverCloud Studio.
msg_subjectE.g. "Message subject from page XYZ."
msg_contentE.g. "Message written by a visitor."

optional parameters(s)

parameter values / comments
visitorVisitor email address. If this address exists, it is added as an unconfirmed subscriber and it will receive the acknowledgement message defined by the parameters below.
ack_subjectE.g. "Autoreply: Thank you for your interest to XYZ."
ack_contentE.g. "We will answer to your message as soon as possible..."

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

None.

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
contact
key
msg_subject
msg_content
visitor
ack_subject
ack_content
 send
request
 clear
response
Response
code
msg
data

discussion