EmailOctopus

EmailOctopus integration (Communication, Marketing). Imported from open-connector.

API key9 toolshttps://emailoctopus.com/api/1.6

GET

emailoctopus_list_lists

List EmailOctopus mailing lists available to the current API key.

/lists

2 parameters

Param	Type	Required	Description
limit	integer	optional	Maximum number of records to return, up to 100.
page	integer	optional	Specific 1-based page number to request.

GET

emailoctopus_get_list

Fetch a single EmailOctopus mailing list by ID.

/lists/{list_id}

1 parameter

Param	Type	Required	Description
list_id	string	required	EmailOctopus list identifier.

GET

emailoctopus_list_list_contacts

List contacts in a specific EmailOctopus mailing list.

/lists/{list_id}/contacts

3 parameters

Param	Type	Required	Description
list_id	string	required	EmailOctopus list identifier.
limit	integer	optional	Maximum number of records to return, up to 100.
page	integer	optional	Specific 1-based page number to request.

GET

emailoctopus_get_list_contact

Fetch a single contact from an EmailOctopus mailing list.

/lists/{list_id}/contacts/{contact_id}

2 parameters

Param	Type	Required	Description
list_id	string	required	EmailOctopus list identifier.
contact_id	string	required	EmailOctopus contact identifier.

POST

emailoctopus_create_list_contact

Create a contact in an EmailOctopus mailing list.

/lists/{list_id}/contacts

5 parameters

Param	Type	Required	Description
list_id	string	required	EmailOctopus list identifier.
email_address	string	required	Contact email address accepted by the official EmailOctopus API.
fields	object	optional	Custom contact fields object accepted by the official EmailOctopus API.
tags	array	optional	Tag names accepted by the official create-contact API.
status	string	optional	Contact status value accepted by the official EmailOctopus API.

PUT

emailoctopus_update_list_contact

Update a contact in an EmailOctopus mailing list.

/lists/{list_id}/contacts/{contact_id}

6 parameters

Param	Type	Required	Description
list_id	string	required	EmailOctopus list identifier.
contact_id	string	required	EmailOctopus contact identifier.
email_address	string	optional	Contact email address accepted by the official EmailOctopus API.
fields	object	optional	Custom contact fields object accepted by the official EmailOctopus API.
tags	object	optional	Tag update map accepted by the official update-contact API.
status	string	optional	Contact status value accepted by the official EmailOctopus API.

DELETE

emailoctopus_delete_list_contact

Delete a contact from an EmailOctopus mailing list.

/lists/{list_id}/contacts/{contact_id}

2 parameters

Param	Type	Required	Description
list_id	string	required	EmailOctopus list identifier.
contact_id	string	required	EmailOctopus contact identifier.

GET

emailoctopus_list_campaigns

List EmailOctopus campaigns available to the current API key.

/campaigns

2 parameters

Param	Type	Required	Description
limit	integer	optional	Maximum number of records to return, up to 100.
page	integer	optional	Specific 1-based page number to request.

GET

emailoctopus_get_campaign

Fetch a single EmailOctopus campaign by ID.

/campaigns/{campaign_id}

1 parameter

Param	Type	Required	Description
campaign_id	string	required	EmailOctopus campaign identifier.