{"openapi":"3.0.0","info":{"description":"Netcore Cloud email delivery CPaaS API (formerly Pepipost) for sending transactional email and managing domains, suppression, subaccounts and reports on api.pepipost.com (Web API v5, docs v5.1)","version":[{"name":"v5","value":"v5"}]},"servers":[{"description":"Netcore Cloud email delivery CPaaS API (formerly Pepipost) for sending transactional email and managing domains, suppression, subaccounts and reports on api.pepipost.com (Web API v5, docs v5.1)","url":"https://api.apirails.com/netcoreemail"}],"paths":{"/v5/mail/send":{"post":{"tags":["Transactional Email"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://cpaasdocs.netcorecloud.com/docs/pepipost-api/c2d895762f832-send-an-email","api_endpoint":"https://api.pepipost.com/v5/mail/send"},"summary":"Send an email","description":"Generate the request to send an email to single or multiple recipients using your sending domain | Netcore Cloud Email (Pepipost) Web API v5 | Source: official Pepipost Python SDK v5.0.0 (PyPI `pepipost`), base https://api.pepipost.com/v5, api_key header auth","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"attachments":{"type":"array","description":"Attachment information","items":{"type":"object","properties":{"content":{"type":"string","description":"Base64 encoded value of the attached file"},"name":{"type":"string","description":"Filename of the attachment"}}}},"bcc":{"type":"array","description":"Global BCC email addresses","items":{"type":"object","properties":{"email":{"type":"string","description":"Email of recipient"},"name":{"type":"string","description":"Name of recipient"}}}},"content":{"type":"array","description":"Email content parts","items":{"type":"object","properties":{"type":{"type":"string","description":"Content type","enum":["html","amp","plain "]},"value":{"type":"string","description":"HTML/text content to be sent in your email"}}}},"from":{"type":"object","description":"Email address representing the sender of the mail","required":true,"properties":{"email":{"type":"string","description":"Sender email address","required":true},"name":{"type":"string","description":"Sender name"}}},"lint_payload":{"type":"boolean","description":"Validate (lint) the payload without sending the email"},"personalizations":{"type":"array","description":"Personalizations (per-recipient data)","items":{"type":"object","properties":{"attachments":{"type":"array","description":"Attachment information"},"attributes":{"type":"object","description":"Dynamic attributes (merge tags)"},"bcc":{"type":"array","description":"BCC email addresses"},"cc":{"type":"array","description":"CC email addresses"},"headers":{"type":"object","description":"Dynamic custom headers"},"to":{"type":"array","description":"To email addresses"},"token_bcc":{"type":"string","description":"Token (JSON string) mapping for bcc recipients"},"token_cc":{"type":"string","description":"Token (JSON string) mapping for cc recipients"},"token_to":{"type":"string","description":"Token (JSON string) mapping for to recipients"}}}},"reply_to":{"type":"string","description":"Email address which recipients can reply to"},"schedule":{"type":"integer","description":"Schedule the time of email delivery (epoch seconds)"},"settings":{"type":"object","description":"Sending settings","properties":{"click_track":{"type":"boolean","description":"Enable or disable click tracking"},"footer":{"type":"boolean","description":"Enable or disable footer"},"hepf":{"type":"boolean","description":"Hide embedded pixel for open tracking"},"open_track":{"type":"boolean","description":"Enable or disable open tracking"},"unsubscribe_track":{"type":"boolean","description":"Enable or disable unsubscribe tracking"}}},"subject":{"type":"string","description":"Subject line of the email"},"tags":{"type":"array","description":"Custom tags to organize your emails","items":{"type":"string"}},"template_id":{"type":"integer","description":"ID of the template to be used for sending the mail"},"to":{"type":"array","description":"To email addresses","required":true,"items":{"type":"object","properties":{"email":{"type":"string","description":"Email of recipient","required":true},"name":{"type":"string","description":"Name of recipient"}}}}}},"example":{"attachments":[],"bcc":[],"content":[],"from":{},"lint_payload":[false],"personalizations":[],"reply_to":"string","schedule":[1508941170],"settings":{},"subject":"string","tags":["tag1"],"template_id":[100],"to":[]}}}}}},"/v5/domain":{"post":{"tags":["Domain"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://cpaasdocs.netcore.ai/docs/pepipost-api/f407e4448ab62-introduction","api_endpoint":"https://api.pepipost.com/v5/domain"},"summary":"Add a sending domain","description":"Add a new sending domain to your account | Netcore Cloud Email (Pepipost) Web API v5 | Source: official Pepipost Python SDK v5.0.0 (PyPI `pepipost`), base https://api.pepipost.com/v5, api_key header auth","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"domain":{"type":"string","description":"The domain you wish to include in the 'From' header of your emails","required":true},"envelopeName":{"type":"string","description":"The subdomain which will be used for tracking opens, clicks and unsubscribe"}}},"example":{"domain":["example.com"],"envelopeName":["track.example.com"]}}}}}},"/v5/domain/delete":{"delete":{"tags":["Domain"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://cpaasdocs.netcore.ai/docs/pepipost-api/f407e4448ab62-introduction","api_endpoint":"https://api.pepipost.com/v5/domain/delete"},"summary":"Delete a sending domain","description":"Delete a sending domain from your account | Netcore Cloud Email (Pepipost) Web API v5 | Source: official Pepipost Python SDK v5.0.0 (PyPI `pepipost`), base https://api.pepipost.com/v5, api_key header auth","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"domain":{"type":"string","description":"Name of the domain to delete","required":true}}},"example":{"domain":["example.com"]}}}}}},"/v5/events":{"get":{"tags":["Events And Reports"],"parameters":[{"name":"email","in":"query","description":"Filter logs based on recipient's email","required":false,"schema":{"type":"string","example":""}},{"name":"enddate","in":"query","description":"The end date of the event logs to retrieve (YYYY-MM-DD). Defaults to today","required":false,"schema":{"type":"string","example":""}},{"name":"events","in":"query","description":"Filter based on email events; multiple comma-separated events allowed","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["processed","sent","open","click","unsubscribe","bounce","softbounce","spam","invalid","dropped","hardbounce"]}}},{"name":"fromaddress","in":"query","description":"Filter logs based on from address","required":false,"schema":{"type":"string","example":""}},{"name":"limit","in":"query","description":"The number of results to return","required":false,"schema":{"type":"integer","example":""}},{"name":"offset","in":"query","description":"The point in the list to begin retrieving results from","required":false,"schema":{"type":"integer","example":""}},{"name":"sort","in":"query","description":"Sort based on email sent time","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["asc","desc"]}}},{"name":"startdate","in":"query","description":"The starting date of the event logs to retrieve (YYYY-MM-DD)","required":true,"schema":{"type":"string","example":""}},{"name":"subject","in":"query","description":"Filter logs based on subject","required":false,"schema":{"type":"string","example":""}},{"name":"xapiheader","in":"query","description":"Filter logs based on recipient's email (x-api-header)","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://cpaasdocs.netcore.ai/docs/pepipost-api/f407e4448ab62-introduction","api_endpoint":"https://api.pepipost.com/v5/events"},"summary":"Get email event logs","description":"Fetch the log of all email events (sent, open, click, bounce, spam, dropped, etc.) | Netcore Cloud Email (Pepipost) Web API v5 | Source: official Pepipost Python SDK v5.0.0 (PyPI `pepipost`), base https://api.pepipost.com/v5, api_key header auth","security":[{"bearerAuth":[]}]}},"/v5/stats":{"get":{"tags":["Events And Reports"],"parameters":[{"name":"aggregated_by","in":"query","description":"Aggregate the statistics by period","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["day","week","month"]}}},{"name":"enddate","in":"query","description":"The end date of the statistics to retrieve (YYYY-MM-DD). Defaults to today","required":false,"schema":{"type":"string","example":""}},{"name":"limit","in":"query","description":"The number of results to return","required":false,"schema":{"type":"integer","example":""}},{"name":"offset","in":"query","description":"The point in the list to begin retrieving results from","required":false,"schema":{"type":"integer","example":""}},{"name":"startdate","in":"query","description":"The starting date of the statistics to retrieve (YYYY-MM-DD)","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://cpaasdocs.netcore.ai/docs/pepipost-api/f407e4448ab62-introduction","api_endpoint":"https://api.pepipost.com/v5/stats"},"summary":"Get aggregate email statistics","description":"Fetch aggregate email statistics (volume, opens, clicks, bounces) for a date range | Netcore Cloud Email (Pepipost) Web API v5 | Source: official Pepipost Python SDK v5.0.0 (PyPI `pepipost`), base https://api.pepipost.com/v5, api_key header auth","security":[{"bearerAuth":[]}]}},"/v5/subaccounts/createSubaccount":{"post":{"tags":["Subaccounts"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://cpaasdocs.netcore.ai/docs/pepipost-api/f407e4448ab62-introduction","api_endpoint":"https://api.pepipost.com/v5/subaccounts/createSubaccount"},"summary":"Create a subaccount","description":"Create a new subaccount under your Netcore Email account | Netcore Cloud Email (Pepipost) Web API v5 | Source: official Pepipost Python SDK v5.0.0 (PyPI `pepipost`), base https://api.pepipost.com/v5, api_key header auth","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"credit_type":{"type":"string","description":"Credit type of the subaccount","enum":["one_time_credit","unlimited"]},"email":{"type":"string","description":"Email address to be registered with the subaccount","required":true},"password":{"type":"string","description":"Required when setpassword=1; minimum 8 characters with one uppercase, one lowercase and one numeric character"},"setpassword":{"type":"string","description":"Set to 1 to define the password here; 0 sends an email confirmation link acting as password reset link","required":true},"username":{"type":"string","description":"Provide a username for the subaccount","required":true}}},"example":{"credit_type":["unlimited"],"email":"string","password":"string","setpassword":["1"],"username":"string"}}}}}},"/v5/subaccounts/updateSubaccount":{"post":{"tags":["Subaccounts"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://cpaasdocs.netcore.ai/docs/pepipost-api/f407e4448ab62-introduction","api_endpoint":"https://api.pepipost.com/v5/subaccounts/updateSubaccount"},"summary":"Update a subaccount","description":"Update a subaccount profile (email, password, credit type) | Netcore Cloud Email (Pepipost) Web API v5 | Source: official Pepipost Python SDK v5.0.0 (PyPI `pepipost`), base https://api.pepipost.com/v5, api_key header auth","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"confirm_password":{"type":"string","description":"Reconfirm the new password for the subaccount"},"credit_type":{"type":"string","description":"Credit type of the subaccount","enum":["one_time_credit","unlimited"]},"new_email":{"type":"string","description":"The new email address to be registered with the subaccount"},"new_password":{"type":"string","description":"The new password of the subaccount"},"username":{"type":"string","description":"The username of the subaccount","required":true}}},"example":{"confirm_password":"string","credit_type":["unlimited"],"new_email":"string","new_password":"string","username":"string"}}}}}},"/v5/subaccounts":{"patch":{"tags":["Subaccounts"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://cpaasdocs.netcore.ai/docs/pepipost-api/f407e4448ab62-introduction","api_endpoint":"https://api.pepipost.com/v5/subaccounts"},"summary":"Enable or disable a subaccount","description":"Enable or disable an existing subaccount | Netcore Cloud Email (Pepipost) Web API v5 | Source: official Pepipost Python SDK v5.0.0 (PyPI `pepipost`), base https://api.pepipost.com/v5, api_key header auth","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"disabled":{"type":"boolean","description":"Flag to indicate whether the subaccount should be enabled or disabled","required":true},"username":{"type":"string","description":"The username of the subaccount","required":true}}},"example":{"disabled":[true],"username":"string"}}}}}},"/v5/subaccounts/setsubaccountcredit":{"post":{"tags":["Subaccounts"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://cpaasdocs.netcore.ai/docs/pepipost-api/f407e4448ab62-introduction","api_endpoint":"https://api.pepipost.com/v5/subaccounts/setsubaccountcredit"},"summary":"Add or subtract subaccount credits","description":"Increase or decrease the credit balance of a subaccount | Netcore Cloud Email (Pepipost) Web API v5 | Source: official Pepipost Python SDK v5.0.0 (PyPI `pepipost`), base https://api.pepipost.com/v5, api_key header auth","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"action":{"type":"string","description":"Indicate the action to be taken on the credits","required":true,"enum":["increase","decrease"]},"amount":{"type":"integer","description":"Amount of credits","required":true},"username":{"type":"string","description":"The username of the subaccount","required":true}}},"example":{"action":"increase","amount":[100],"username":"string"}}}}}},"/v5/setrecurringcreditddetails":{"post":{"tags":["Subaccounts"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://cpaasdocs.netcore.ai/docs/pepipost-api/f407e4448ab62-introduction","api_endpoint":"https://api.pepipost.com/v5/setrecurringcreditddetails"},"summary":"Set recurring credits of a subaccount","description":"Configure recurring credit allocation details for a subaccount | Netcore Cloud Email (Pepipost) Web API v5 | Source: official Pepipost Python SDK v5.0.0 (PyPI `pepipost`), base https://api.pepipost.com/v5, api_key header auth","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"end_date":{"type":"string","description":"The last date of credit allocation (YYYY-MM-DD)"},"recurring_credit":{"type":"integer","description":"The amount to be added periodically","required":true},"start_date":{"type":"string","description":"The date from which the credit allocation will commence (YYYY-MM-DD)"},"status":{"type":"string","description":"Flag to enable or disable the recurring credit allocation"},"timeperiod":{"type":"string","description":"The periodicity of the recurring credit allocation","required":true,"enum":["daily","weekly","monthly"]},"username":{"type":"string","description":"The username of the subaccount","required":true}}},"example":{"end_date":["2026-12-31"],"recurring_credit":[100],"start_date":["2026-01-01"],"status":["enable"],"timeperiod":"daily","username":"string"}}}}}},"/v5/subaccounts/getSubAccounts":{"get":{"tags":["Subaccounts"],"parameters":[{"name":"limit","in":"query","description":"The number of results to return","required":true,"schema":{"type":"integer","example":""}},{"name":"offset","in":"query","description":"The point in the list to begin retrieving results from","required":true,"schema":{"type":"integer","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://cpaasdocs.netcore.ai/docs/pepipost-api/f407e4448ab62-introduction","api_endpoint":"https://api.pepipost.com/v5/subaccounts/getSubAccounts"},"summary":"List subaccounts","description":"List all subaccounts under your Netcore Email account | Netcore Cloud Email (Pepipost) Web API v5 | Source: official Pepipost Python SDK v5.0.0 (PyPI `pepipost`), base https://api.pepipost.com/v5, api_key header auth","security":[{"bearerAuth":[]}]}},"/v5/subaccounts/delete":{"delete":{"tags":["Subaccounts"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://cpaasdocs.netcore.ai/docs/pepipost-api/f407e4448ab62-introduction","api_endpoint":"https://api.pepipost.com/v5/subaccounts/delete"},"summary":"Delete a subaccount","description":"Delete an existing subaccount | Netcore Cloud Email (Pepipost) Web API v5 | Source: official Pepipost Python SDK v5.0.0 (PyPI `pepipost`), base https://api.pepipost.com/v5, api_key header auth","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"username":{"type":"string","description":"The username of the subaccount","required":true}}},"example":{"username":"string"}}}}}},"/v5/suppression":{"post":{"tags":["Suppression"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://cpaasdocs.netcore.ai/docs/pepipost-api/f407e4448ab62-introduction","api_endpoint":"https://api.pepipost.com/v5/suppression"},"summary":"Add email or domain to suppression list","description":"Add an email address or domain to the suppression list | Netcore Cloud Email (Pepipost) Web API v5 | Source: official Pepipost Python SDK v5.0.0 (PyPI `pepipost`), base https://api.pepipost.com/v5, api_key header auth","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"domain":{"type":"string","description":"Domain(s) to suppress — emails to recipients at this domain will not be delivered; comma separate multiple domains"},"email":{"type":"string","description":"Email address(es) to suppress; comma separate the values to suppress multiple email addresses"}}},"example":{"domain":["example.com"],"email":["user@example.com"]}}}}},"delete":{"tags":["Suppression"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://cpaasdocs.netcore.ai/docs/pepipost-api/f407e4448ab62-introduction","api_endpoint":"https://api.pepipost.com/v5/suppression"},"summary":"Remove email or domain from suppression list","description":"Remove an email address or domain from the suppression list | Netcore Cloud Email (Pepipost) Web API v5 | Source: official Pepipost Python SDK v5.0.0 (PyPI `pepipost`), base https://api.pepipost.com/v5, api_key header auth","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"domain":{"type":"string","description":"Domain(s) to remove from the suppression list; comma separate multiple domains"},"email":{"type":"string","description":"Email address(es) to remove from the suppression list; comma separate multiple email addresses"}}},"example":{"domain":["example.com"],"email":["user@example.com"]}}}}}}},"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer"}}},"security":[{"bearerAuth":[]}]}