Guest User

Pepipost Swagger spec

a guest
Mar 31st, 2016
153
0
Never
Not a member of Pastebin yet? Sign Up, it unlocks many cool features!
text 7.36 KB | None | 0 0
  1. swagger: '2.0'
  2. info:
  3. version: 1.0.0
  4. title: Pepipost API v1.0
  5. description: Pepipost API documentation
  6. schemes:
  7. # - https
  8. - http
  9. basePath: /
  10. host: api.pepipost.dev
  11. paths:
  12. /v1/emails.json:
  13. post:
  14. tags:
  15. - Email
  16. description: >
  17. `Sending Mails` – This API is used for sending emails. PepiPost supports
  18. REST as well JSON formats for the input
  19. parameters:
  20. - name: api_key
  21. in: formData
  22. description: Your API Key
  23. required: true
  24. type: string
  25. format: secret value
  26. - name: fromname
  27. in: formData
  28. description: Email Sender name
  29. required: false
  30. type: string
  31. format: url encoded
  32. - name: from
  33. in: formData
  34. description: From email address
  35. required: true
  36. type: string
  37. format: url encoded
  38. - name: replytoid
  39. in: formData
  40. description: Reply to email address
  41. required: false
  42. type: string
  43. format: url encoded
  44. - name: subject
  45. in: formData
  46. description: Subject of the Email
  47. required: true
  48. type: string
  49. format: url encoded
  50. - name: content
  51. in: formData
  52. description: Email body in html (to use attributes to display dynamic values such as name, account number, etc. for ex. [% NAME %].)
  53. required: true
  54. type: string
  55. format: url encoded
  56. - name: footer
  57. in: formData
  58. description: Set '0' or '1' in order to include footer or not
  59. required: false
  60. type: boolean
  61. default: true
  62. - name: template
  63. in: formData
  64. description: Email template ID
  65. required: false
  66. type: integer
  67. - name: attachmentid
  68. in: formData
  69. description: specify uploaded attachments id (Multiple attachments are allowed)
  70. required: false
  71. type: array
  72. items:
  73. type: integer
  74. - name: clicktrack
  75. in: formData
  76. description: set ‘0’ or ‘1’ in-order to disable or enable the click-track
  77. required: false
  78. type: boolean
  79. default: true
  80. - name: opentrack
  81. in: formData
  82. description: set open-track value to ‘0’ or ‘1’ in-order to disable or enable
  83. required: false
  84. type: boolean
  85. default: true
  86. - name: bcc
  87. in: formData
  88. description: Email address for bcc
  89. required: false
  90. type: array
  91. items:
  92. type: string
  93. - name: recipients[]
  94. in: formData
  95. description: Email addresses for recipients (multiple values allowed).
  96. required: true
  97. type: array
  98. items:
  99. type: string
  100. - name: x-apiheader
  101. in: formData
  102. description: Your defined unique identifier
  103. required: false
  104. type: array
  105. items:
  106. type: string
  107. format: url encoded
  108. - name: tags[]
  109. in: formData
  110. description: To relate each message. Useful for reports.
  111. required: false
  112. type: array
  113. items:
  114. type: string
  115. format: url encoded
  116. - name: attributenames
  117. in: formData
  118. description: Specify attributes names
  119. required: false
  120. type: array
  121. items:
  122. type: string
  123. format: urlencoded
  124. - name: attributevalues
  125. in: formData
  126. description: Specify attributes values
  127. required: false
  128. type: array
  129. items:
  130. type: string
  131. format: urlencoded
  132. responses:
  133. '200':
  134. description: 'Success | Failure'
  135. /api/web.send.rest:
  136. get:
  137. tags:
  138. - Email
  139. description: >
  140. `Sending Mails` – This API is used for sending emails. PepiPost supports
  141. REST as well JSON formats for the input
  142. parameters:
  143. - name: api_key
  144. in: query
  145. description: Your API Key
  146. required: true
  147. type: string
  148. format: secret value
  149. - name: fromname
  150. in: query
  151. description: Email Sender name
  152. required: false
  153. type: string
  154. format: url encoded
  155. - name: from
  156. in: query
  157. description: From email address
  158. required: true
  159. type: string
  160. format: url encoded
  161. - name: replytoid
  162. in: query
  163. description: Reply to email address
  164. required: false
  165. type: string
  166. format: url encoded
  167. - name: subject
  168. in: query
  169. description: Subject of the Email
  170. required: true
  171. type: string
  172. format: url encoded
  173. - name: content
  174. in: query
  175. description: Email body in html (to use attributes to display dynamic values such as name, account number, etc. for ex. [% NAME %] for ATT_NAME , [% AGE %] for ATT_AGE etc.)
  176. required: true
  177. type: string
  178. format: url encoded
  179. - name: footer
  180. in: query
  181. description: Set '0' or '1' in order to include footer or not
  182. required: false
  183. type: boolean
  184. default: true
  185. - name: template
  186. in: query
  187. description: Email template ID
  188. required: false
  189. type: integer
  190. - name: attachmentid
  191. in: query
  192. description: specify uploaded attachments id (Multiple attachments are allowed)
  193. required: false
  194. type: string
  195. - name: clicktrack
  196. in: query
  197. description: set ‘0’ or ‘1’ in-order to disable or enable the click-track
  198. required: false
  199. type: boolean
  200. default: true
  201. - name: opentrack
  202. in: query
  203. description: set open-track value to ‘0’ or ‘1’ in-order to disable or enable
  204. required: false
  205. type: boolean
  206. default: true
  207. - name: bcc
  208. in: query
  209. description: Email address for bcc
  210. required: false
  211. type: string
  212. - name: recipients
  213. in: query
  214. description: Email addresses for recipients (multiple values allowed)
  215. required: true
  216. type: string
  217. format: url encoded
  218. - name: 'ATT_NAME'
  219. in: query
  220. description: Specify attributes followed by ATT_ for recipient to personalized email for ex. ATT_NAME for name, ATT_AGE for age etc. (Multiple attributes are allowed)
  221. required: false
  222. type: string
  223. format: urlencoded
  224. - name: X-APIHEADER
  225. in: query
  226. description: Your defined unique identifier
  227. required: false
  228. type: string
  229. format: url encoded
  230. - name: tags
  231. in: query
  232. description: To relate each message. Useful for reports.
  233. required: false
  234. type: string
  235. format: url encoded
  236. default: ''
  237. responses:
  238. '200':
  239. description: 'Success | Failure'
Add Comment
Please, Sign In to add comment