openapi: 3.0.3 info: title: Sender-Api description: 'Sender api documentation.' version: 1.0.0 servers: - url: 'https://api.sender.net' paths: /v2/active_subscribers: get: summary: 'GET - ' description: '' parameters: - in: header name: Authorization description: '' example: 'Bearer [your-token]' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: { } tags: - '' /v2/delete_me: post: summary: 'POST - ' description: '' parameters: - in: header name: Authorization description: '' example: 'Bearer [your-token]' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: { } tags: - '' /v2/additional_info: post: summary: 'POST - ' description: '' parameters: - in: header name: Authorization description: '' example: 'Bearer [your-token]' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: { } tags: - '' '/v2/campaigns/{id}/attachments': get: summary: 'GET - ' description: '' parameters: - in: header name: Authorization description: '' example: 'Bearer [your-token]' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: { } tags: - '' post: summary: 'POST - ' description: '' parameters: - in: header name: Authorization description: '' example: 'Bearer [your-token]' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: { } tags: - '' requestBody: required: true content: application/json: schema: type: object properties: file: type: 'string requiredField' description: 'File type accepted: doc,docx,xml,pdf,xlsx,xls,jpg,jpeg,png,svg.' example: repudiandae required: - file delete: summary: 'DELETE - ' description: '' parameters: - in: header name: Authorization description: '' example: 'Bearer [your-token]' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: 200: description: '' content: application/json: schema: type: object example: success: true message: '' properties: success: { type: boolean, example: true } message: { type: string, example: '' } tags: - '' requestBody: required: true content: application/json: schema: type: object properties: file_name: type: 'string requiredField' description: 'File name.' example: repudiandae required: - file_name parameters: - in: path name: id description: '' example: '[_id]' required: true schema: type: integer /v2/attachment/delete: post: summary: 'POST - ' description: '' parameters: - in: header name: Authorization description: '' example: 'Bearer [your-token]' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: { } tags: - '' requestBody: required: true content: application/json: schema: type: object properties: file_name: type: 'string requiredField' description: 'File name.' example: repudiandae required: - file_name /v2/plans: get: summary: 'GET - ' description: '' parameters: - in: header name: Authorization description: '' example: 'Bearer [your-token]' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: { } tags: - '' '/v2/plans/{plan_id}': get: summary: 'GET - ' description: '' parameters: - in: header name: Authorization description: '' example: 'Bearer [your-token]' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: { } tags: - '' parameters: - in: path name: plan_id description: '' example: '[plan_id]' required: true schema: type: integer /v2/campaigns: get: summary: 'GET - ' description: '' parameters: - in: header name: Authorization description: '' example: 'Bearer [your-token]' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: { } tags: - '' post: summary: 'POST - ' description: '' parameters: - in: header name: Authorization description: '' example: 'Bearer [your-token]' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: { } tags: - '' requestBody: required: true content: application/json: schema: type: object properties: title: type: string description: 'Campaign title.' example: 'Enter your campaign title' subject: type: 'string requiredField' description: 'Subject of email that would be sent.' example: 'Enter the subject for your email campaign' from: type: 'string requiredField' description: 'Email from.' example: 'email received from - John Doe' reply_to: type: 'string requiredField' description: 'Email reply to.' example: your@verifyDomainEmail.com google_analytics: type: number description: 'Enable or disable google analytics on the campaign.' example: !!float 1 auto_followup_subject: type: string description: 'Follow up of your@verifyDomainEmail.com.' example: 'Follow up of your@verifyDomainEmail.com' auto_followup_delay: type: number description: 'The value must be one of 12, 24, 48, 72, 96, 120, 144, or 168.' example: !!float 72 auto_followup_active: type: boolean description: '' example: false last_action: type: string description: '' example: api content_type: type: 'string requiredField' description: 'The value must be one of editor, html, or text.' example: html required: - subject - from - reply_to - content_type delete: summary: 'DELETE - ' description: '' parameters: - in: header name: Authorization description: '' example: 'Bearer [your-token]' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: 200: description: '' content: application/json: schema: type: object example: success: true message: '' properties: success: { type: boolean, example: true } message: { type: string, example: '' } tags: - '' '/v2/campaigns/{id}': get: summary: 'GET - ' description: '' parameters: - in: header name: Authorization description: '' example: 'Bearer [your-token]' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: { } tags: - '' patch: summary: 'PATCH - ' description: '' parameters: - in: header name: Authorization description: '' example: 'Bearer [your-token]' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: 200: description: '' content: application/json: schema: type: object example: success: true message: ' updated' properties: success: { type: boolean, example: true } message: { type: string, example: ' updated' } tags: - '' requestBody: required: false content: application/json: schema: type: object properties: title: type: string description: 'Campaign title.' example: 'Updated campaign title' subject: type: string description: 'Subject of email that would be sent.' example: 'Updated campaign subject' from: type: string description: 'Email from.' example: your@verifyDomainEmail.com reply_to: type: string description: 'Email reply to.' example: your@verifyDomainEmail.com google_analytics: type: number description: 'Enable or disable.' example: !!float 1 auto_followup_subject: type: string description: 'Follow up of support@sender.net.' example: 'Follow up of support@sender.net' auto_followup_delay: type: number description: 'The value must be one of 12, 24, 48, 72, 96, 120, 144, or 168.' example: !!float 12 auto_followup_active: type: boolean description: '' example: false content_type: type: string description: 'The value must be one of editor, html, or text editor, html or text_editor.' example: editor domain_id: type: number description: 'Use a different domain, you can retrieve the domain ids, using route get all domains.' example: !!float 2 parameters: - in: path name: id description: '' example: '[_id]' required: true schema: type: integer '/v2/campaigns/{id}/send': post: summary: 'POST - ' description: '' parameters: - in: header name: Authorization description: '' example: 'Bearer [your-token]' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: { } tags: - '' parameters: - in: path name: id description: '' example: '[_id]' required: true schema: type: integer '/v2/campaigns/{id}/sending_status': get: summary: 'GET - ' description: '' parameters: - in: header name: Authorization description: '' example: 'Bearer [your-token]' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: { } tags: - '' parameters: - in: path name: id description: '' example: '[_id]' required: true schema: type: integer '/v2/campaigns/{id}/schedule': delete: summary: 'DELETE - ' description: '' parameters: - in: header name: Authorization description: '' example: 'Bearer [your-token]' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: 200: description: '' content: application/json: schema: type: object example: success: true message: '' properties: success: { type: boolean, example: true } message: { type: string, example: '' } tags: - '' post: summary: 'POST - ' description: '' parameters: - in: header name: Authorization description: '' example: 'Bearer [your-token]' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: { } tags: - '' requestBody: required: true content: application/json: schema: type: object properties: schedule_time: type: 'string requiredField' description: 'The value must be a valid date in the format Y-m-d H:i:s.' example: '2025-11-19 17:08:17' required: - schedule_time parameters: - in: path name: id description: '' example: '[_id]' required: true schema: type: integer '/v2/campaigns/{id}/events': get: summary: 'GET - ' description: '' parameters: - in: header name: Authorization description: '' example: 'Bearer [your-token]' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: { } tags: - '' parameters: - in: path name: id description: '' example: '[_id]' required: true schema: type: integer '/v2/campaigns/{id}/opens': get: summary: 'GET - ' description: '' parameters: - in: header name: Authorization description: '' example: 'Bearer [your-token]' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: { } tags: - '' parameters: - in: path name: id description: '' example: '[_id]' required: true schema: type: integer '/v2/campaigns/{id}/clicks': get: summary: 'GET - ' description: '' parameters: - in: header name: Authorization description: '' example: 'Bearer [your-token]' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: { } tags: - '' parameters: - in: path name: id description: '' example: '[_id]' required: true schema: type: integer '/v2/campaigns/{id}/bounces': get: summary: 'GET - ' description: '' parameters: - in: header name: Authorization description: '' example: 'Bearer [your-token]' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: { } tags: - '' parameters: - in: path name: id description: '' example: '[_id]' required: true schema: type: integer '/v2/campaigns/{id}/unsubscribes': get: summary: 'GET - ' description: '' parameters: - in: header name: Authorization description: '' example: 'Bearer [your-token]' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: { } tags: - '' parameters: - in: path name: id description: '' example: '[_id]' required: true schema: type: integer '/v2/campaigns/{id}/complaints': get: summary: 'GET - ' description: '' parameters: - in: header name: Authorization description: '' example: 'Bearer [your-token]' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: { } tags: - '' parameters: - in: path name: id description: '' example: '[_id]' required: true schema: type: integer '/v2/campaigns/{id}/unopens': get: summary: 'GET - ' description: '' parameters: - in: header name: Authorization description: '' example: 'Bearer [your-token]' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: { } tags: - '' parameters: - in: path name: id description: '' example: '[_id]' required: true schema: type: integer '/v2/campaigns/{id}/report': get: summary: 'GET - ' description: '' parameters: - in: header name: Authorization description: '' example: 'Bearer [your-token]' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: { } tags: - '' parameters: - in: path name: id description: '' example: '[_id]' required: true schema: type: integer '/v2/campaigns/{id}/{type}/export': get: summary: 'GET - ' description: '' parameters: - in: header name: Authorization description: '' example: 'Bearer [your-token]' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: { } tags: - '' requestBody: required: false content: application/json: schema: type: object properties: type: type: string description: 'The value must be one of events, opens, clicks, bounces, unsubscribes, complaints, or unopens.' example: clicks parameters: - in: path name: id description: '' example: '[_id]' required: true schema: type: integer - in: path name: type description: '' example: '[type]' required: true schema: type: string '/v2/campaigns/{id}/groups': get: summary: 'GET - ' description: '' parameters: - in: header name: Authorization description: '' example: 'Bearer [your-token]' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: { } tags: - '' parameters: - in: path name: id description: '' example: '[_id]' required: true schema: type: integer '/v2/campaigns/{id}/link_clicks/{linkId}': get: summary: 'GET - ' description: '' parameters: - in: header name: Authorization description: '' example: 'Bearer [your-token]' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: { } tags: - '' parameters: - in: path name: id description: '' example: '[_id]' required: true schema: type: integer - in: path name: linkId description: '' example: '[linkId]' required: true schema: type: integer '/v2/campaigns/{id}/last_action': post: summary: 'POST - ' description: '' parameters: - in: header name: Authorization description: '' example: 'Bearer [your-token]' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: { } tags: - '' requestBody: required: true content: application/json: schema: type: object properties: last_action: type: 'string requiredField' description: 'The value must be one of step1, editor, step3, or step4.' example: step1 required: - last_action parameters: - in: path name: id description: '' example: '[_id]' required: true schema: type: integer '/v2/campaigns/{id}/preview': get: summary: 'GET - ' description: '' parameters: - in: header name: Authorization description: '' example: 'Bearer [your-token]' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: { } tags: - '' parameters: - in: path name: id description: '' example: '[_id]' required: true schema: type: integer '/v2/campaigns/{id}/plain_preview': get: summary: 'GET - ' description: '' parameters: - in: header name: Authorization description: '' example: 'Bearer [your-token]' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: { } tags: - '' parameters: - in: path name: id description: '' example: '[_id]' required: true schema: type: integer '/v2/campaigns/{id}/copy': post: summary: 'POST - ' description: '' parameters: - in: header name: Authorization description: '' example: 'Bearer [your-token]' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: { } tags: - '' parameters: - in: path name: id description: '' example: '[_id]' required: true schema: type: integer '/v2/campaigns/{id}/pdf': get: summary: 'GET - ' description: '' parameters: - in: header name: Authorization description: '' example: 'Bearer [your-token]' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: { } tags: - '' parameters: - in: path name: id description: '' example: '[_id]' required: true schema: type: integer '/v2/campaigns/{id}/share': get: summary: 'GET - ' description: '' parameters: - in: header name: Authorization description: '' example: 'Bearer [your-token]' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: { } tags: - '' parameters: - in: path name: id description: '' example: '[_id]' required: true schema: type: integer '/v2/campaigns/{id}/send_test_email': post: summary: 'POST - ' description: '' parameters: - in: header name: Authorization description: '' example: 'Bearer [your-token]' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: { } tags: - '' requestBody: required: true content: application/json: schema: type: object properties: address: type: 'string requiredField' description: 'The value must be a valid email address.' example: support@sender.net required: - address parameters: - in: path name: id description: '' example: '[_id]' required: true schema: type: integer '/v2/campaigns/{id}/errors': get: summary: 'GET - ' description: '' parameters: - in: header name: Authorization description: '' example: 'Bearer [your-token]' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: { } tags: - '' parameters: - in: path name: id description: '' example: '[_id]' required: true schema: type: integer '/v2/campaigns/{id}/follow_up': post: summary: 'POST - ' description: '' parameters: - in: header name: Authorization description: '' example: 'Bearer [your-token]' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: { } tags: - '' requestBody: required: true content: application/json: schema: type: object properties: subject: type: 'string requiredField' description: '' example: 'Subject text' time: type: 'string requiredField' description: 'The value must be one of 12, 24, 48, 72, 96, 120, 144, or 168.' example: 72 required: - subject - time delete: summary: 'DELETE - ' description: '' parameters: - in: header name: Authorization description: '' example: 'Bearer [your-token]' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: 200: description: '' content: application/json: schema: type: object example: success: true message: '' properties: success: { type: boolean, example: true } message: { type: string, example: '' } tags: - '' parameters: - in: path name: id description: '' example: '[_id]' required: true schema: type: integer '/v2/campaigns/{id}/tags/set': post: summary: 'POST - ' description: '' parameters: - in: header name: Authorization description: '' example: 'Bearer [your-token]' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: { } tags: - '' requestBody: required: false content: application/json: schema: type: object properties: tags_arr: type: array description: 'You can provide an array with the tag_id''s you want assign this campaign.' example: 'tag_id1, tag_id2' parameters: - in: path name: id description: '' example: '[_id]' required: true schema: type: integer '/v2/campaigns/{id}/tags': get: summary: 'GET - ' description: '' parameters: - in: header name: Authorization description: '' example: 'Bearer [your-token]' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: { } tags: - '' parameters: - in: path name: id description: '' example: '[_id]' required: true schema: type: integer '/v2/campaigns/{id}/tags/{tagId}': get: summary: 'GET - ' description: '' parameters: - in: header name: Authorization description: '' example: 'Bearer [your-token]' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: { } tags: - '' post: summary: 'POST - ' description: '' parameters: - in: header name: Authorization description: '' example: 'Bearer [your-token]' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: { } tags: - '' delete: summary: 'DELETE - ' description: '' parameters: - in: header name: Authorization description: '' example: 'Bearer [your-token]' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: 200: description: '' content: application/json: schema: type: object example: success: true message: '' properties: success: { type: boolean, example: true } message: { type: string, example: '' } tags: - '' parameters: - in: path name: id description: '' example: '[_id]' required: true schema: type: integer - in: path name: tagId description: '' example: '[tagId]' required: true schema: type: integer '/v2/campaigns/{id}/exclude_tags/{tagId}': post: summary: 'POST - ' description: '' parameters: - in: header name: Authorization description: '' example: 'Bearer [your-token]' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: { } tags: - '' delete: summary: 'DELETE - ' description: '' parameters: - in: header name: Authorization description: '' example: 'Bearer [your-token]' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: 200: description: '' content: application/json: schema: type: object example: success: true message: '' properties: success: { type: boolean, example: true } message: { type: string, example: '' } tags: - '' parameters: - in: path name: id description: '' example: '[_id]' required: true schema: type: integer - in: path name: tagId description: '' example: '[tagId]' required: true schema: type: integer '/v2/campaigns/{id}/exclude_tags': get: summary: 'GET - ' description: '' parameters: - in: header name: Authorization description: '' example: 'Bearer [your-token]' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: { } tags: - '' parameters: - in: path name: id description: '' example: '[_id]' required: true schema: type: integer '/v2/campaigns/{id}/filters': get: summary: 'GET - ' description: '' parameters: - in: header name: Authorization description: '' example: 'Bearer [your-token]' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: { } tags: - '' post: summary: 'POST - ' description: '' parameters: - in: header name: Authorization description: '' example: 'Bearer [your-token]' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: { } tags: - '' delete: summary: 'DELETE - ' description: '' parameters: - in: header name: Authorization description: '' example: 'Bearer [your-token]' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: 200: description: '' content: application/json: schema: type: object example: success: true message: '' properties: success: { type: boolean, example: true } message: { type: string, example: '' } tags: - '' parameters: - in: path name: id description: '' example: '[_id]' required: true schema: type: integer '/v2/campaigns/{id}/filters/{filterId}': get: summary: 'GET - ' description: '' parameters: - in: header name: Authorization description: '' example: 'Bearer [your-token]' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: { } tags: - '' parameters: - in: path name: id description: '' example: '[_id]' required: true schema: type: integer - in: path name: filterId description: '' example: '[filterId]' required: true schema: type: integer '/v2/campaigns/{id}/filters/set': post: summary: 'POST - ' description: '' parameters: - in: header name: Authorization description: '' example: 'Bearer [your-token]' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: { } tags: - '' requestBody: required: true content: application/json: schema: type: object properties: filters_arr: type: 'array requiredField' description: 'You can provide an array with the filter_id''s you want assign this campaign.' example: [repudiandae] required: - filters_arr parameters: - in: path name: id description: '' example: '[_id]' required: true schema: type: integer '/v2/campaigns/{id}/exclude_filters': get: summary: 'GET - ' description: '' parameters: - in: header name: Authorization description: '' example: 'Bearer [your-token]' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: { } tags: - '' post: summary: 'POST - ' description: '' parameters: - in: header name: Authorization description: '' example: 'Bearer [your-token]' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: { } tags: - '' delete: summary: 'DELETE - ' description: '' parameters: - in: header name: Authorization description: '' example: 'Bearer [your-token]' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: 200: description: '' content: application/json: schema: type: object example: success: true message: '' properties: success: { type: boolean, example: true } message: { type: string, example: '' } tags: - '' parameters: - in: path name: id description: '' example: '[_id]' required: true schema: type: integer '/v2/campaigns/{id}/subscribers': get: summary: 'GET - ' description: '' parameters: - in: header name: Authorization description: '' example: 'Bearer [your-token]' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: { } tags: - '' parameters: - in: path name: id description: '' example: '[_id]' required: true schema: type: integer '/v2/campaigns/{id}/cancel_followup': post: summary: 'POST - ' description: '' parameters: - in: header name: Authorization description: '' example: 'Bearer [your-token]' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: { } tags: - '' parameters: - in: path name: id description: '' example: '[_id]' required: true schema: type: integer /v2/campaigns/prefill: get: summary: 'GET - ' description: '' parameters: - in: header name: Authorization description: '' example: 'Bearer [your-token]' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: { } tags: - '' '/v2/campaigns/{id}/links': get: summary: 'GET - ' description: '' parameters: - in: header name: Authorization description: '' example: 'Bearer [your-token]' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: { } tags: - '' parameters: - in: path name: id description: '' example: '[_id]' required: true schema: type: integer '/v2/campaigns/{id}/send_to_all': patch: summary: 'PATCH - ' description: '' parameters: - in: header name: Authorization description: '' example: 'Bearer [your-token]' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: 200: description: '' content: application/json: schema: type: object example: success: true message: ' updated' properties: success: { type: boolean, example: true } message: { type: string, example: ' updated' } tags: - '' parameters: - in: path name: id description: '' example: '[_id]' required: true schema: type: integer /v2/carts: post: summary: 'POST - ' description: '' parameters: - in: header name: Authorization description: '' example: 'Bearer [your-token]' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: { } tags: - '' requestBody: required: true content: application/json: schema: type: object properties: external_id: type: 'number requiredField' description: '' example: 12345 email: type: 'string requiredField' description: 'The value must be a valid email address. Email address of the domain.' example: subscriber@email.com url: type: 'string requiredField' description: 'Url of the location of the cart.' example: www.store-url-of-cart-information.com products: type: array description: '' example: [[]] items: { type: object, properties: { sku: { type: string, description: '', example: 'sku number' }, name: { type: string, description: '', example: 'product name' }, price: { type: string, description: '', example: '26.00' }, price_display: { type: string, description: 'Price with currency.', example: '26 EUR' }, qty: { type: number, description: 'Quantity of the product.', example: !!float 1 }, image: { type: string, description: '', example: www.link-to-the-product-image.jpg } } } currency: type: string description: 'Currency abbreviation.' example: eur order_total: type: string description: '' example: '30' tax_total: type: string description: '' example: '4' required: - external_id - email - url get: summary: 'GET - ' description: '' parameters: - in: header name: Authorization description: '' example: 'Bearer [your-token]' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: { } tags: - '' '/v2/carts/{cart_hash}': get: summary: 'GET - ' description: '' parameters: - in: header name: Authorization description: '' example: 'Bearer [your-token]' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: { } tags: - '' parameters: - in: path name: cart_hash description: '' example: '[cart_hash]' required: true schema: type: string '/v2/carts/{external_id}': delete: summary: 'DELETE - ' description: '' parameters: - in: header name: Authorization description: '' example: 'Bearer [your-token]' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: 200: description: '' content: application/json: schema: type: object example: success: true message: '' properties: success: { type: boolean, example: true } message: { type: string, example: '' } tags: - '' parameters: - in: path name: external_id description: '' example: '[external_id]' required: true schema: type: integer '/v2/carts/{external_id}/convert': post: summary: 'POST - ' description: '' parameters: - in: header name: Authorization description: '' example: 'Bearer [your-token]' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: { } tags: - '' parameters: - in: path name: external_id description: '' example: '[external_id]' required: true schema: type: integer /v2/EditorImports/getProductData: get: summary: 'GET - ' description: '' parameters: - in: header name: Authorization description: '' example: 'Bearer [your-token]' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: { } tags: - '' '/v2/upload/v2/{id}/{folderId}': post: summary: 'POST - ' description: '' parameters: - in: header name: Authorization description: '' example: 'Bearer [your-token]' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: { } tags: - '' parameters: - in: path name: id description: '' example: '[_id]' required: true schema: type: integer - in: path name: folderId description: '' example: '[folderId]' required: true schema: type: integer /v2/userImages/bulkDelete: post: summary: 'POST - ' description: '' parameters: - in: header name: Authorization description: '' example: 'Bearer [your-token]' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: { } tags: - '' /v2/imageFolders: get: summary: 'GET - ' description: '' parameters: - in: header name: Authorization description: '' example: 'Bearer [your-token]' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: { } tags: - '' '/v2/imageFolders/view/{selector}': get: summary: 'GET - ' description: '' parameters: - in: header name: Authorization description: '' example: 'Bearer [your-token]' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: { } tags: - '' parameters: - in: path name: selector description: '' example: '[selector]' required: true schema: type: string /v2/imageFolders/add: post: summary: 'POST - ' description: '' parameters: - in: header name: Authorization description: '' example: 'Bearer [your-token]' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: { } tags: - '' '/v2/imageFolders/delete/{folderId}': post: summary: 'POST - ' description: '' parameters: - in: header name: Authorization description: '' example: 'Bearer [your-token]' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: { } tags: - '' parameters: - in: path name: folderId description: '' example: '[folderId]' required: true schema: type: integer '/v2/userImages/getGiphy/{selector}': get: summary: 'GET - ' description: '' parameters: - in: header name: Authorization description: '' example: 'Bearer [your-token]' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: { } tags: - '' parameters: - in: path name: selector description: '' example: '[selector]' required: true schema: type: string /v2/unsplash/get: get: summary: 'GET - ' description: '' parameters: - in: header name: Authorization description: '' example: 'Bearer [your-token]' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: { } tags: - '' '/v2/editor/{htmlId}': get: summary: 'GET - ' description: '' parameters: - in: header name: Authorization description: '' example: 'Bearer [your-token]' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: { } tags: - '' parameters: - in: path name: htmlId description: '' example: '[htmlId]' required: true schema: type: integer '/v2/editor/language/{lang}': get: summary: 'GET - ' description: '' parameters: - in: header name: Authorization description: '' example: 'Bearer [your-token]' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: { } tags: - '' parameters: - in: path name: lang description: '' example: '[lang]' required: true schema: type: string /v2/unsubscribes: get: summary: 'GET - ' description: '' parameters: - in: header name: Authorization description: '' example: 'Bearer [your-token]' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: { } tags: - '' post: summary: 'POST - ' description: '' parameters: - in: header name: Authorization description: '' example: 'Bearer [your-token]' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: { } tags: - '' /v2/fields: post: summary: 'POST - ' description: '' parameters: - in: header name: Authorization description: '' example: 'Bearer [your-token]' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: { } tags: - '' requestBody: required: true content: application/json: schema: type: object properties: title: type: 'string requiredField' description: 'Field title.' example: extra type: type: 'string requiredField' description: 'The value must be one of number, text, or datetime

Type meanings:
Value accepted for number: 123, must be a numeric value.
Value accepted for text: "string"
Value accepted for datetime type: In Y-m-d H:i:s format, like example; 2021-01-05 10:56:04

.' example: text required: - title - type get: summary: 'GET - ' description: '' parameters: - in: header name: Authorization description: '' example: 'Bearer [your-token]' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: { } tags: - '' '/v2/fields/{id}': get: summary: 'GET - ' description: '' parameters: - in: header name: Authorization description: '' example: 'Bearer [your-token]' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: { } tags: - '' patch: summary: 'PATCH - ' description: '' parameters: - in: header name: Authorization description: '' example: 'Bearer [your-token]' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: 200: description: '' content: application/json: schema: type: object example: success: true message: ' updated' properties: success: { type: boolean, example: true } message: { type: string, example: ' updated' } tags: - '' requestBody: required: false content: application/json: schema: type: object properties: title: type: string description: 'New field title.' example: 'Updated title' show: type: boolean description: '' example: true delete: summary: 'DELETE - ' description: '' parameters: - in: header name: Authorization description: '' example: 'Bearer [your-token]' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: 200: description: '' content: application/json: schema: type: object example: success: true message: '' properties: success: { type: boolean, example: true } message: { type: string, example: '' } tags: - '' parameters: - in: path name: id description: '' example: '[_id]' required: true schema: type: integer /v2/fields/reorder: post: summary: 'POST - ' description: '' parameters: - in: header name: Authorization description: '' example: 'Bearer [your-token]' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: { } tags: - '' /v2/filters: post: summary: 'POST - ' description: '' parameters: - in: header name: Authorization description: '' example: 'Bearer [your-token]' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: { } tags: - '' requestBody: required: true content: application/json: schema: type: object properties: conditions: type: 'array requiredField' description: 'Campaign title.' example: [repudiandae] name: type: 'string requiredField' description: '' example: repudiandae required: - conditions - name get: summary: 'GET - ' description: '' parameters: - in: header name: Authorization description: '' example: 'Bearer [your-token]' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: { } tags: - '' '/v2/filters/{id}': get: summary: 'GET - ' description: '' parameters: - in: header name: Authorization description: '' example: 'Bearer [your-token]' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: { } tags: - '' patch: summary: 'PATCH - ' description: '' parameters: - in: header name: Authorization description: '' example: 'Bearer [your-token]' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: 200: description: '' content: application/json: schema: type: object example: success: true message: ' updated' properties: success: { type: boolean, example: true } message: { type: string, example: ' updated' } tags: - '' requestBody: required: false content: application/json: schema: type: object properties: conditions: type: array description: '' example: 'Campaign title' name: type: string description: '' example: repudiandae delete: summary: 'DELETE - ' description: '' parameters: - in: header name: Authorization description: '' example: 'Bearer [your-token]' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: 200: description: '' content: application/json: schema: type: object example: success: true message: '' properties: success: { type: boolean, example: true } message: { type: string, example: '' } tags: - '' parameters: - in: path name: id description: '' example: '[_id]' required: true schema: type: integer /v2/links: get: summary: 'GET - ' description: '' parameters: - in: header name: Authorization description: '' example: 'Bearer [your-token]' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: { } tags: - '' /v2/next_payment: get: summary: 'GET - ' description: '' parameters: - in: header name: Authorization description: '' example: 'Bearer [your-token]' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: { } tags: - '' /v2/payment_methods: get: summary: 'GET - ' description: '' parameters: - in: header name: Authorization description: '' example: 'Bearer [your-token]' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: { } tags: - '' post: summary: 'POST - ' description: '' parameters: - in: header name: Authorization description: '' example: 'Bearer [your-token]' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: { } tags: - '' requestBody: required: true content: application/json: schema: type: object properties: nonce: type: 'string requiredField' description: '' example: repudiandae required: - nonce '/v2/payment_methods/{id}': delete: summary: 'DELETE - ' description: '' parameters: - in: header name: Authorization description: '' example: 'Bearer [your-token]' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: 200: description: '' content: application/json: schema: type: object example: success: true message: '' properties: success: { type: boolean, example: true } message: { type: string, example: '' } tags: - '' patch: summary: 'PATCH - ' description: '' parameters: - in: header name: Authorization description: '' example: 'Bearer [your-token]' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: 200: description: '' content: application/json: schema: type: object example: success: true message: ' updated' properties: success: { type: boolean, example: true } message: { type: string, example: ' updated' } tags: - '' parameters: - in: path name: id description: '' example: '[_id]' required: true schema: type: integer '/v2/campaigns/{id}/stats': get: summary: 'GET - ' description: '' parameters: - in: header name: Authorization description: '' example: 'Bearer [your-token]' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: { } tags: - '' parameters: - in: path name: id description: '' example: '[_id]' required: true schema: type: integer '/v2/campaigns/{id}/links_report': get: summary: 'GET - ' description: '' parameters: - in: header name: Authorization description: '' example: 'Bearer [your-token]' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: { } tags: - '' parameters: - in: path name: id description: '' example: '[_id]' required: true schema: type: integer '/v2/campaigns/{id}/heatmap_report': get: summary: 'GET - ' description: '' parameters: - in: header name: Authorization description: '' example: 'Bearer [your-token]' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: { } tags: - '' parameters: - in: path name: id description: '' example: '[_id]' required: true schema: type: integer '/v2/campaigns/{id}/ua_data_report': get: summary: 'GET - ' description: '' parameters: - in: header name: Authorization description: '' example: 'Bearer [your-token]' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: { } tags: - '' parameters: - in: path name: id description: '' example: '[_id]' required: true schema: type: integer '/v2/campaigns/{id}/chart_data': get: summary: 'GET - ' description: '' parameters: - in: header name: Authorization description: '' example: 'Bearer [your-token]' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: { } tags: - '' parameters: - in: path name: id description: '' example: '[_id]' required: true schema: type: integer '/v2/campaigns/{id}/geography_opens': get: summary: 'GET - ' description: '' parameters: - in: header name: Authorization description: '' example: 'Bearer [your-token]' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: { } tags: - '' parameters: - in: path name: id description: '' example: '[_id]' required: true schema: type: integer '/v2/campaigns/{id}/geography_actions': get: summary: 'GET - ' description: '' parameters: - in: header name: Authorization description: '' example: 'Bearer [your-token]' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: { } tags: - '' parameters: - in: path name: id description: '' example: '[_id]' required: true schema: type: integer '/v2/campaigns/{id}/geography_clicks': get: summary: 'GET - ' description: '' parameters: - in: header name: Authorization description: '' example: 'Bearer [your-token]' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: { } tags: - '' parameters: - in: path name: id description: '' example: '[_id]' required: true schema: type: integer '/v2/campaigns/{id}/links/{link_id}/report/export': get: summary: 'GET - ' description: '' parameters: - in: header name: Authorization description: '' example: 'Bearer [your-token]' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: { } tags: - '' parameters: - in: path name: id description: '' example: '[_id]' required: true schema: type: integer - in: path name: link_id description: '' example: '[link_id]' required: true schema: type: integer /v2/subscribers/file_import: post: summary: 'POST - ' description: '' parameters: - in: header name: Authorization description: '' example: 'Bearer [your-token]' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: { } tags: - '' /v2/subscribers/start_import: post: summary: 'POST - ' description: '' parameters: - in: header name: Authorization description: '' example: 'Bearer [your-token]' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: { } tags: - '' requestBody: required: true content: application/json: schema: type: object properties: columns: type: array description: '' example: [repudiandae] emailColumn: type: 'string requiredField' description: '' example: repudiandae firstnameColumn: type: string description: '' example: { } lastnameColumn: type: string description: '' example: { } customFieldColumns: type: string description: '' example: { } fileName: type: 'string requiredField' description: '' example: repudiandae tags: type: array description: '' example: [repudiandae] rowCount: type: 'string requiredField' description: '' example: repudiandae source: type: string description: '' example: { } required: - emailColumn - fileName - rowCount /v2/subscribers/text_import: post: summary: 'POST - ' description: '' parameters: - in: header name: Authorization description: '' example: 'Bearer [your-token]' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: { } tags: - '' requestBody: required: true content: application/json: schema: type: object properties: subscribers: type: 'string requiredField' description: '' example: repudiandae required: - subscribers /v2/subscribers/xlsx_example: get: summary: 'GET - ' description: '' parameters: - in: header name: Authorization description: '' example: 'Bearer [your-token]' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: { } tags: - '' /v2/subscribers/csv_example: get: summary: 'GET - ' description: '' parameters: - in: header name: Authorization description: '' example: 'Bearer [your-token]' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: { } tags: - '' '/v2/subscribers/{id}/events': get: summary: 'GET - ' description: '' parameters: - in: header name: Authorization description: '' example: 'Bearer [your-token]' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: { } tags: - '' parameters: - in: path name: id description: '' example: '[_id]' required: true schema: type: integer '/v2/subscribers/tags/{tagId}': post: summary: 'POST - ' description: '' parameters: - in: header name: Authorization description: '' example: 'Bearer [your-token]' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: { } tags: - '' delete: summary: 'DELETE - ' description: '' parameters: - in: header name: Authorization description: '' example: 'Bearer [your-token]' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: 200: description: '' content: application/json: schema: type: object example: success: true message: '' properties: success: { type: boolean, example: true } message: { type: string, example: '' } tags: - '' parameters: - in: path name: tagId description: '' example: '[tagId]' required: true schema: type: integer /v2/subscribers: get: summary: 'GET - ' description: '' parameters: - in: header name: Authorization description: '' example: 'Bearer [your-token]' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: { } tags: - '' delete: summary: 'DELETE - ' description: '' parameters: - in: header name: Authorization description: '' example: 'Bearer [your-token]' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: 200: description: '' content: application/json: schema: type: object example: success: true message: '' properties: success: { type: boolean, example: true } message: { type: string, example: '' } tags: - '' post: summary: 'POST - ' description: '' parameters: - in: header name: Authorization description: '' example: 'Bearer [your-token]' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: { } tags: - '' requestBody: required: true content: application/json: schema: type: object properties: email: type: 'string requiredField' description: 'The value must be a valid email address. Provide a valid email.' example: newSubscriber@email.com firstname: type: string description: '' example: firstname lastname: type: string description: '' example: lastname tags: type: array description: 'Add the name of the tag or tags to be included to:
tags[0] = tag name 1, tags[1] = tag name 2.' example: [title1] required: - email '/v2/subscribers/{id}': get: summary: 'GET - ' description: '' parameters: - in: header name: Authorization description: '' example: 'Bearer [your-token]' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: { } tags: - '' patch: summary: 'PATCH - ' description: '' parameters: - in: header name: Authorization description: '' example: 'Bearer [your-token]' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: 200: description: '' content: application/json: schema: type: object example: success: true message: ' updated' properties: success: { type: boolean, example: true } message: { type: string, example: ' updated' } tags: - '' requestBody: required: false content: application/json: schema: type: object properties: firstname: type: string description: '' example: repudiandae lastname: type: string description: '' example: repudiandae fullname: type: string description: '' example: repudiandae created: type: string description: '' example: repudiandae status: type: string description: '' example: repudiandae parameters: - in: path name: id description: '' example: '[_id]' required: true schema: type: integer /v2/subscribers/before_delete: get: summary: 'GET - ' description: '' parameters: - in: header name: Authorization description: '' example: 'Bearer [your-token]' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: { } tags: - '' '/v2/subscribers/{id}/fields/{fieldId}': patch: summary: 'PATCH - ' description: '' parameters: - in: header name: Authorization description: '' example: 'Bearer [your-token]' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: 200: description: '' content: application/json: schema: type: object example: success: true message: ' updated' properties: success: { type: boolean, example: true } message: { type: string, example: ' updated' } tags: - '' delete: summary: 'DELETE - ' description: '' parameters: - in: header name: Authorization description: '' example: 'Bearer [your-token]' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: 200: description: '' content: application/json: schema: type: object example: success: true message: '' properties: success: { type: boolean, example: true } message: { type: string, example: '' } tags: - '' parameters: - in: path name: id description: '' example: '[_id]' required: true schema: type: integer - in: path name: fieldId description: '' example: '[fieldId]' required: true schema: type: integer /v2/active_subscribers_count: get: summary: 'GET - ' description: '' parameters: - in: header name: Authorization description: '' example: 'Bearer [your-token]' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: { } tags: - '' /v2/subscribers/export: post: summary: 'POST - ' description: '' parameters: - in: header name: Authorization description: '' example: 'Bearer [your-token]' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: { } tags: - '' requestBody: required: false content: application/json: schema: type: object properties: conditions: type: 'Array or all' description: 'Provide "all" and will select all the subscribers.' example: all subscribers: type: array description: 'Provide as an array the subscribers id.' example: [subscriber_id, other_subscriber_id] export_type: type: 'Array or all' description: 'The value must be one of csv or xlsx.' example: csv /v2/subscribers/reactivate: post: summary: 'POST - ' description: '' parameters: - in: header name: Authorization description: '' example: 'Bearer [your-token]' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: { } tags: - '' requestBody: required: false content: application/json: schema: type: object properties: conditions: type: 'Array or all' description: 'Provide "all" and will select all the subscribers.' example: all subscribers: type: array description: 'Provide as an array the subscribers id.' example: [subscriber_id, other_subscriber_id] export_type: type: 'Array or all' description: 'The value must be one of csv or xlsx.' example: csv /v2/subscribers/mailchimp_lists: post: summary: 'POST - ' description: '' parameters: - in: header name: Authorization description: '' example: 'Bearer [your-token]' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: { } tags: - '' /v2/subscribers/mailchimp_import: post: summary: 'POST - ' description: '' parameters: - in: header name: Authorization description: '' example: 'Bearer [your-token]' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: { } tags: - '' /v2/subscribers/create_update: post: summary: 'POST - ' description: '' parameters: - in: header name: Authorization description: '' example: 'Bearer [your-token]' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: { } tags: - '' '/v2/subscribers/integrations/{email_hash}': get: summary: 'GET - ' description: '' parameters: - in: header name: Authorization description: '' example: 'Bearer [your-token]' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: { } tags: - '' parameters: - in: path name: email_hash description: '' example: '[email_hash]' required: true schema: type: string /v2/tags: post: summary: 'POST - ' description: '' parameters: - in: header name: Authorization description: '' example: 'Bearer [your-token]' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: { } tags: - '' requestBody: required: true content: application/json: schema: type: object properties: title: type: 'string requiredField' description: 'Tag name title.' example: 'Tag title' required: - title get: summary: 'GET - ' description: '' parameters: - in: header name: Authorization description: '' example: 'Bearer [your-token]' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: { } tags: - '' /v2/tags/has_active_workflow: post: summary: 'POST - ' description: '' parameters: - in: header name: Authorization description: '' example: 'Bearer [your-token]' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: { } tags: - '' '/v2/tags/{id}': delete: summary: 'DELETE - ' description: '' parameters: - in: header name: Authorization description: '' example: 'Bearer [your-token]' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: 200: description: '' content: application/json: schema: type: object example: success: true message: '' properties: success: { type: boolean, example: true } message: { type: string, example: '' } tags: - '' patch: summary: 'PATCH - ' description: '' parameters: - in: header name: Authorization description: '' example: 'Bearer [your-token]' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: 200: description: '' content: application/json: schema: type: object example: success: true message: ' updated' properties: success: { type: boolean, example: true } message: { type: string, example: ' updated' } tags: - '' get: summary: 'GET - ' description: '' parameters: - in: header name: Authorization description: '' example: 'Bearer [your-token]' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: { } tags: - '' parameters: - in: path name: id description: '' example: '[_id]' required: true schema: type: integer '/v2/tags/{id}/add_opens/{linkId}': post: summary: 'POST - ' description: '' parameters: - in: header name: Authorization description: '' example: 'Bearer [your-token]' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: { } tags: - '' parameters: - in: path name: id description: '' example: '[_id]' required: true schema: type: integer - in: path name: linkId description: '' example: '[linkId]' required: true schema: type: integer '/v2/tags/{id}/activity': get: summary: 'GET - ' description: '' parameters: - in: header name: Authorization description: '' example: 'Bearer [your-token]' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: { } tags: - '' parameters: - in: path name: id description: '' example: '[_id]' required: true schema: type: integer '/v2/message/{id}/send': post: summary: 'POST - ' description: '' parameters: - in: header name: Authorization description: '' example: 'Bearer [your-token]' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: { } tags: - '' requestBody: required: true content: application/json: schema: type: object properties: recipient_email: type: 'string requiredField' description: '' example: repudiandae attachments: type: array description: '' example: [repudiandae] variables: type: array description: '' example: [repudiandae] required: - recipient_email parameters: - in: path name: id description: '' example: '[_id]' required: true schema: type: integer /v2/access_tokens: get: summary: 'GET - ' description: '' parameters: - in: header name: Authorization description: '' example: 'Bearer [your-token]' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: { } tags: - '' post: summary: 'POST - ' description: '' parameters: - in: header name: Authorization description: '' example: 'Bearer [your-token]' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: { } tags: - '' requestBody: required: true content: application/json: schema: type: object properties: expires_in: type: 'string requiredField' description: 'The value must be one of 1, 7, 30, or forever.' example: '1' required: - expires_in '/v2/access_tokens/{id}': patch: summary: 'PATCH - ' description: '' parameters: - in: header name: Authorization description: '' example: 'Bearer [your-token]' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: 200: description: '' content: application/json: schema: type: object example: success: true message: ' updated' properties: success: { type: boolean, example: true } message: { type: string, example: ' updated' } tags: - '' delete: summary: 'DELETE - ' description: '' parameters: - in: header name: Authorization description: '' example: 'Bearer [your-token]' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: 200: description: '' content: application/json: schema: type: object example: success: true message: '' properties: success: { type: boolean, example: true } message: { type: string, example: '' } tags: - '' parameters: - in: path name: id description: '' example: '[_id]' required: true schema: type: integer /v2/hooks: post: summary: 'POST - ' description: '' parameters: - in: header name: Authorization description: '' example: 'Bearer [your-token]' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: { } tags: - '' requestBody: required: true content: application/json: schema: type: object properties: hook_trigger: type: 'string requiredField' description: "Available hooks: new_campaign, new_subscriber_in_tag, new_subscribers_list, new_unsubscriber_from_tag,\n unsubscribe, new_subscriber, get_campaigns, get_subscribers, get_tags." example: repudiandae relation_id: type: number description: '' example: 88.485284012 url: type: 'string requiredField' description: 'Url that would be getting the hook responses.' example: repudiandae required: - hook_trigger - url '/v2/hooks/{type}': delete: summary: 'DELETE - ' description: '' parameters: - in: header name: Authorization description: '' example: 'Bearer [your-token]' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: 200: description: '' content: application/json: schema: type: object example: success: true message: '' properties: success: { type: boolean, example: true } message: { type: string, example: '' } tags: - '' parameters: - in: path name: type description: '' example: '[type]' required: true schema: type: string /v2/current/hooks: get: summary: 'GET - ' description: '' parameters: - in: header name: Authorization description: '' example: 'Bearer [your-token]' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: { } tags: - '' /v2/audit_log_triggers: get: summary: 'GET - ' description: '' parameters: - in: header name: Authorization description: '' example: 'Bearer [your-token]' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: { } tags: - '' /v2/register: post: summary: 'POST - ' description: '' parameters: - in: header name: Authorization description: '' example: 'Bearer [your-token]' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: { } tags: - '' requestBody: required: true content: application/json: schema: type: object properties: title: type: 'string requiredField' description: '' example: repudiandae email: type: 'string requiredField' description: 'The value must be a valid email address.' example: cfeest@example.net password: type: 'string requiredField' description: '' example: repudiandae required: - title - email - password /v2/firebase/token: get: summary: 'GET - ' description: '' parameters: - in: header name: Authorization description: '' example: 'Bearer [your-token]' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: { } tags: - '' /v2/me: get: summary: 'GET - ' description: '' parameters: - in: header name: Authorization description: '' example: 'Bearer [your-token]' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: { } tags: - '' '/v2/editor/exit/{html_id}': get: summary: 'GET - ' description: '' parameters: - in: header name: Authorization description: '' example: 'Bearer [your-token]' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: { } tags: - '' parameters: - in: path name: html_id description: '' example: '[html_id]' required: true schema: type: integer /v2/reset_password: post: summary: 'POST - ' description: '' parameters: - in: header name: Authorization description: '' example: 'Bearer [your-token]' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: { } tags: - '' requestBody: required: true content: application/json: schema: type: object properties: email: type: 'string requiredField' description: 'The value must be a valid email address. Provide a valid email which has access to sender platform.' example: cfeest@example.net required: - email /v2/confirm_token: get: summary: 'GET - ' description: '' parameters: - in: header name: Authorization description: '' example: 'Bearer [your-token]' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: { } tags: - '' /v2/customers_count: get: summary: 'GET - ' description: '' parameters: - in: header name: Authorization description: '' example: 'Bearer [your-token]' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: { } tags: - '' /v2/account_questionnaire: patch: summary: 'PATCH - ' description: '' parameters: - in: header name: Authorization description: '' example: 'Bearer [your-token]' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: 200: description: '' content: application/json: schema: type: object example: success: true message: ' updated' properties: success: { type: boolean, example: true } message: { type: string, example: ' updated' } tags: - '' requestBody: required: false content: application/json: schema: type: object properties: title: type: string description: '' example: repudiandae company_code: type: number description: '' example: 88.485284012 vat_code: type: number description: '' example: 88.485284012 country: type: string description: '' example: repudiandae city: type: string description: '' example: repudiandae address: type: string description: '' example: repudiandae utm_campaign: type: string description: '' example: repudiandae utm_source: type: string description: '' example: repudiandae utm_medium: type: string description: '' example: repudiandae timezone: type: string description: '' example: repudiandae /v2/user_questionnaire: patch: summary: 'PATCH - ' description: '' parameters: - in: header name: Authorization description: '' example: 'Bearer [your-token]' schema: type: string - in: header name: Content-Type description: '' example: application/json schema: type: string - in: header name: Accept description: '' example: application/json schema: type: string responses: 200: description: '' content: application/json: schema: type: object example: success: true message: ' updated' properties: success: { type: boolean, example: true } message: { type: string, example: ' updated' } tags: - '' requestBody: required: true content: application/json: schema: type: object properties: name: type: 'string requiredField' description: '' example: repudiandae surname: type: 'string requiredField' description: '' example: repudiandae website: type: 'string requiredField' description: '' example: repudiandae required: - name - surname - website components: securitySchemes: default: type: http scheme: bearer description: '' security: - default: []