API

Docs and API's for Weasy.io

Newsletter

Manage all the newsletter subscription in your website.

Accepts GET POST PUT DELETE

All requests to the API must be authenticated with an API key on the HTTP Authorization header.

GET

Get all files from website filemanager

GET/newsletter{?limit,page}

Request example

~ curl -i -X GET \
-H 'X-API-KEY:xsFPVLn7aOllXixPDaGBgCZpyTmyX7G6CniNtKD' \
-H 'Content-Type:application/json' \
https://api.weasy.io/v1/newsletter



Body response example [ HTTP CODE: 200 ]

{  
   "items":[  
      {  
         "id":6,
         "email":"info@weasy.io",
         "status":1,
         "lang":"en"
      },
      {  
         "id":2,
         "name":"weasy support",
         "email":"support@weasy.io",
         "status":1,
         "lang":"pt"
      },
      {  
         "id":3,
         "name":null,
         "email":"sales@weasy.io",
         "status":1,
         "lang":"pt"
      },
      ...
   ],
   "paging":{  
      "total":"100",
      "totalpages":4,
      "previous":"https://api.weasy.io/v1/newsletter?limit=25&page=1",
      "next":"https://api.weasy.io/v1/newsletter?limit=25&page=3"
   }
}



Path parameters

NAME TYPE REQUIRED DESCRIPTION
limit integer optional define items per page
page integer optional define page to display


POST

Add a contact or collection of contacts to your newsletter database.


POST/newsletter

Request example

~ curl -i -X POST \
-H 'X-API-KEY:xsFPVLn7aOllXixPDaGBgCZpyTmyX7G6CniNtKD' \
-H 'Content-Type:application/json' \
-d '[{"name":"Contact 1","email":"email1@weasy.io","status":1,"lang":"en"},{"name":"Contact 2","email":"email2@weasy.io","status":0,"lang":"en"}]'\
https://api.weasy.io/v1/newsletter



Body response example [ HTTP CODE: 200 ]

[  
   {  
      "status":"ok",
      "email":"email1@weasy.io",
      "id":1189
   },
   {  
      "status":"error",
      "email":"email2@weasy.io"
   }
]



Body attributes

A json payload containing the following attributes.

NAME TYPE REQUIRED DESCRIPTION
name string optional define name of the contact
email string required define the email of the contact
status integer required define the status of the contact.
options:
1 for active, 0 for inactive
lang string optional define the language of the contact
options:
all the iso country codes (ISO 3166-2) obtained from the Languages endpoint


PUT

Change a contact from your newsletter database.


PUT/newsletter/:id

Request example

~ curl -i -X POST \
-H 'X-API-KEY:xsFPVLn7aOllXixPDaGBgCZpyTmyX7G6CniNtKD' \
-H 'Content-Type:application/json' \
-d '{"name":"Contact 1 changed","email":"email1@weasy.io","status":1,"lang":"en"}'\
https://api.weasy.io/v1/newsletter/1



Body response example [ HTTP CODE: 200 ]

{  
   "status":"ok",
   "email":"email1@weasy.io"
}
or
{  
   "status":"error",
   "email":"email1@weasy.io"
}



Path parameters

NAME TYPE REQUIRED DESCRIPTION
id integer required contact id



Body attributes

A json payload containing the following attributes.

NAME TYPE REQUIRED DESCRIPTION
name string optional define name of the contact
email string required define the email of the contact
status integer required define the status of the contact.
options:
1 for active, 0 for inactive
lang string optional define the language of the contact
options:
all the iso country codes (ISO 3166-2) obtained from the Languages endpoint


DELETE

Delete a contact or collection of contacts from your newsletter database.


DELETE/newsletter

Request example

~ curl -i -X DELETE \
-H 'X-API-KEY:xsFPVLn7aOllXixPDaGBgCZpyTmyX7G6CniNtKD' \
-H 'Content-Type:application/json' \
-d '["email1@weasy.io","email2@weasy.io"]'\
https://api.weasy.io/v1/newsletter



Body response example [ HTTP CODE: 200 ]

[  
   {  
      "status":"ok",
      "email":"email1@weasy.io",
   },
   {  
      "status":"error",
      "email":"email2@weasy.io",
   }
]



Body attributes

Attribute description
A json payload containing an array of file or files.