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.3.tar.gz (2.4 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.3-py3-none-any.whl (2.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: yonoma-0.1.3.tar.gz
  • Upload date:
  • Size: 2.4 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.3.tar.gz
Algorithm Hash digest
SHA256 8b549739924f68ac0003eca28c5a3e46ae98b04c4613c7a51db4be1351727beb
MD5 d27892b7096b29f79de213032f3386d4
BLAKE2b-256 a6dcbc90353b1fea933897961db88cb8de69a0c645776011f54c35411a274214

See more details on using hashes here.

File details

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

File metadata

  • Download URL: yonoma-0.1.3-py3-none-any.whl
  • Upload date:
  • Size: 2.2 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.3-py3-none-any.whl
Algorithm Hash digest
SHA256 73a38babbb838b9e695c6bcb96c48a2469d351f19f2b4f5afcb86a303096bb69
MD5 4edf0b3558a4c252ce83f25f834c23b6
BLAKE2b-256 efb7b5681e0faa72e99a6338f6440f7ec3afac7959fb1167a60894bcc7638083

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