Skip to main content

A Python client for the Yonoma API

Project description

Yonoma Email Marketing Python SDK

The official Python client library for the Yonoma Email Marketing API.


📥 Installation

Install via pip:

pip install yonoma

or manually install from GitHub:

pip install git+https://github.com/SuthishTwinarcus/yonoma.git

🚀 Quick Start

Note: This SDK requires Python 3.7 or above.

from yonoma.client import YonomaClient

# Initialize the client
yonoma = YonomaClient(api_key="YOUR-API-KEY")

📂 Features

📌 Lists

Create a new lists

from yonoma.lists import Lists

Lists = Lists(yonoma)

response = Lists.create(list_name="New lists")
print(response)

Get a list of Lists

response = Lists.list_all()
print(response)

Retrieve a specific lists

response = Lists.retrieve(list_id="list_id")
print(response)

Update a lists

response = Lists.update(list_id="A0SADFD6PJ", list_name="Updated lists Name")
print(response)

Delete a lists

response = Lists.delete(list_id="list_id")
print(response)

📌 Tags

Create a new tag

from yonoma.tags import Tags

tags = Tags(yonoma)

response = tags.create(tag_name="New Tag")
print(response)

Get a list of tags

response = tags.list_all()
print(response)

Retrieve a specific tag

response = tags.retrieve(tag_id="TAG_ID")
print(response)

Update a tag

response = tags.update(tag_id="TAG_ID", tag_name="Updated Tag Name")
print(response)

Delete a tag

response = tags.delete(tag_id="TAG_ID")
print(response)

📌 Contacts

Create a new contact

from yonoma.contacts import Contacts

contacts = Contacts(yonoma)

response = contacts.create(
    list_id="list_id",
    email="email@example.com",
    status="Subscribed",  # or "Unsubscribed"
    data={
        "firstName": "Contact",
        "lastName": "One",
        "phone": "1234567890",
        "address": "123, NY street",
        "city": "NY City",
        "state": "NY",
        "country": "US",
        "zipcode": "10001"
    }
)
print(response)

Update a contact

response = contacts.update(
    list_id="list_id",
    contact_id="CONTACT_ID",
    status="Subscribed"  # or "Unsubscribed"
)
print(response)

Add a tag to a contact

response = contacts.add_tag(contact_id="CONTACT_ID", tag_id="TAG_ID")
print(response)

Remove a tag from a contact

response = contacts.remove_tag(contact_id="CONTACT_ID", tag_id="TAG_ID")
print(response)

🔗 Useful Links


📜 License

This package is licensed under the MIT License.


This is the official Python SDK for Yonoma Email Marketing, providing seamless API integrations. 🚀

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

yonoma-0.1.4.tar.gz (3.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

yonoma-0.1.4-py3-none-any.whl (4.5 kB view details)

Uploaded Python 3

File details

Details for the file yonoma-0.1.4.tar.gz.

File metadata

  • Download URL: yonoma-0.1.4.tar.gz
  • Upload date:
  • Size: 3.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.2

File hashes

Hashes for yonoma-0.1.4.tar.gz
Algorithm Hash digest
SHA256 a2a84b62b893bd2f97b0fdb406b4906812d266b8354e66fae7632cbfaa7b952a
MD5 9c4f7034ae6cee4089d8b371bbea9b28
BLAKE2b-256 f24dfb3654eaf7f4367314fa891116a9c0001e94bb348a2af9c334461d3d7cce

See more details on using hashes here.

File details

Details for the file yonoma-0.1.4-py3-none-any.whl.

File metadata

  • Download URL: yonoma-0.1.4-py3-none-any.whl
  • Upload date:
  • Size: 4.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.2

File hashes

Hashes for yonoma-0.1.4-py3-none-any.whl
Algorithm Hash digest
SHA256 04b05d5717eed46f050e2422a4d54ce0a108db7a9787f886a0b320d7c3e6c04d
MD5 89f28fc9428a4a34af73886ad4ff255d
BLAKE2b-256 a0a887bb29a4ec27de0c772ae0167284ed00136098f0b846bd7d20f57fd25f92

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page