Get your API Key

SendYellow provides a simple API to deliver email campaigns to any list and template created or to add new contacts to any list created. You need any paid plan to use our API.

API Access Key & Authentication

After signing up, every user is assigned a personal API access key, a unique combination of letters and digits provided to access to our API endpoint. To authenticate with the SendYellow API, simply include your bearer token in the Authorization header.

Headers

Header	Description
Authorization	[Required] Should be Bearer access_key.

Use this service to create a new campaign and trigger a new immediate sending with one simple API call.

API Features

Object	Description
list_id	[Required] ID of the list where you want to send the email. Check lists API IDs here
template_id	[Required] ID of the HTML template you want to use for the email. Check your templates API IDs here
subject	[Required] Subject of your campaign
sending_name	[Required] Name of your sender

Response Object

Property	Description
message	Returns an error message or success message depending on whether or not your API call succeeds.
campaign_id	Returns the campaign ID of the new campaign you created.
success	Returns true or false depending on whether or not your API call succeeds.

Use this service to add new emails to your lists.

API Features

Object	Description
list_id	[Required] ID of the list where you want to add your email. Check lists API IDs here
email	[Required] Email address of your contact to be added using this API service

Response Object

Property	Description
message	Returns an error message or success message depending on whether or not your API call succeeds.
contact_id	Returns the contact ID of the new contact you created.
success	Returns true or false depending on whether or not your API call succeeds.

Use this service to delete emails on your lists.

API Features

Object	Description
list_id	[Required] ID of the list where you want to add your email. Check lists API IDs here
email	[Required] Email address of your contact to be deleted using this API service

Response Object

Property	Description
message	Returns an error message or success message depending on whether or not your API call succeeds.
success	Returns true or false depending on whether or not your API call succeeds.