Not a member of Pastebin yet?
Sign Up,
it unlocks many cool features!
- swagger: '2.0'
- info:
- version: 1.0.0
- title: Pepipost API v1.0
- description: Pepipost API documentation
- schemes:
- # - https
- - http
- basePath: /
- host: api.pepipost.dev
- paths:
- /v1/emails.json:
- post:
- tags:
- - Email
- description: >
- `Sending Mails` – This API is used for sending emails. PepiPost supports
- REST as well JSON formats for the input
- parameters:
- - name: api_key
- in: formData
- description: Your API Key
- required: true
- type: string
- format: secret value
- - name: fromname
- in: formData
- description: Email Sender name
- required: false
- type: string
- format: url encoded
- - name: from
- in: formData
- description: From email address
- required: true
- type: string
- format: url encoded
- - name: replytoid
- in: formData
- description: Reply to email address
- required: false
- type: string
- format: url encoded
- - name: subject
- in: formData
- description: Subject of the Email
- required: true
- type: string
- format: url encoded
- - name: content
- in: formData
- description: Email body in html (to use attributes to display dynamic values such as name, account number, etc. for ex. [% NAME %].)
- required: true
- type: string
- format: url encoded
- - name: footer
- in: formData
- description: Set '0' or '1' in order to include footer or not
- required: false
- type: boolean
- default: true
- - name: template
- in: formData
- description: Email template ID
- required: false
- type: integer
- - name: attachmentid
- in: formData
- description: specify uploaded attachments id (Multiple attachments are allowed)
- required: false
- type: array
- items:
- type: integer
- - name: clicktrack
- in: formData
- description: set ‘0’ or ‘1’ in-order to disable or enable the click-track
- required: false
- type: boolean
- default: true
- - name: opentrack
- in: formData
- description: set open-track value to ‘0’ or ‘1’ in-order to disable or enable
- required: false
- type: boolean
- default: true
- - name: bcc
- in: formData
- description: Email address for bcc
- required: false
- type: array
- items:
- type: string
- - name: recipients[]
- in: formData
- description: Email addresses for recipients (multiple values allowed).
- required: true
- type: array
- items:
- type: string
- - name: x-apiheader
- in: formData
- description: Your defined unique identifier
- required: false
- type: array
- items:
- type: string
- format: url encoded
- - name: tags[]
- in: formData
- description: To relate each message. Useful for reports.
- required: false
- type: array
- items:
- type: string
- format: url encoded
- - name: attributenames
- in: formData
- description: Specify attributes names
- required: false
- type: array
- items:
- type: string
- format: urlencoded
- - name: attributevalues
- in: formData
- description: Specify attributes values
- required: false
- type: array
- items:
- type: string
- format: urlencoded
- responses:
- '200':
- description: 'Success | Failure'
- /api/web.send.rest:
- get:
- tags:
- - Email
- description: >
- `Sending Mails` – This API is used for sending emails. PepiPost supports
- REST as well JSON formats for the input
- parameters:
- - name: api_key
- in: query
- description: Your API Key
- required: true
- type: string
- format: secret value
- - name: fromname
- in: query
- description: Email Sender name
- required: false
- type: string
- format: url encoded
- - name: from
- in: query
- description: From email address
- required: true
- type: string
- format: url encoded
- - name: replytoid
- in: query
- description: Reply to email address
- required: false
- type: string
- format: url encoded
- - name: subject
- in: query
- description: Subject of the Email
- required: true
- type: string
- format: url encoded
- - name: content
- in: query
- 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.)
- required: true
- type: string
- format: url encoded
- - name: footer
- in: query
- description: Set '0' or '1' in order to include footer or not
- required: false
- type: boolean
- default: true
- - name: template
- in: query
- description: Email template ID
- required: false
- type: integer
- - name: attachmentid
- in: query
- description: specify uploaded attachments id (Multiple attachments are allowed)
- required: false
- type: string
- - name: clicktrack
- in: query
- description: set ‘0’ or ‘1’ in-order to disable or enable the click-track
- required: false
- type: boolean
- default: true
- - name: opentrack
- in: query
- description: set open-track value to ‘0’ or ‘1’ in-order to disable or enable
- required: false
- type: boolean
- default: true
- - name: bcc
- in: query
- description: Email address for bcc
- required: false
- type: string
- - name: recipients
- in: query
- description: Email addresses for recipients (multiple values allowed)
- required: true
- type: string
- format: url encoded
- - name: 'ATT_NAME'
- in: query
- 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)
- required: false
- type: string
- format: urlencoded
- - name: X-APIHEADER
- in: query
- description: Your defined unique identifier
- required: false
- type: string
- format: url encoded
- - name: tags
- in: query
- description: To relate each message. Useful for reports.
- required: false
- type: string
- format: url encoded
- default: ''
- responses:
- '200':
- description: 'Success | Failure'
Add Comment
Please, Sign In to add comment