- Overview
- to get started
- Cloud content
- Cloud Data
- User Subscription
- User Session
- User Profile
- Email services
- Utilities
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_subject | E.g. "Message subject from page XYZ." |
msg_content | E.g. "Message written by a visitor." |
optional parameters(s)
parameter | values / comments |
---|---|
visitor | Visitor 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_subject | E.g. "Autoreply: Thank you for your interest to XYZ." |
ack_content | E.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
request
response