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.2.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.2-py3-none-any.whl (2.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: yonoma-0.1.2.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.2.tar.gz
Algorithm Hash digest
SHA256 07c1520ccd8fd7ba353eea6bcb63dd67a9f3d127c00eca12b97a04f970c90019
MD5 55ac13edc556fe3b4ff32ed15168d7c7
BLAKE2b-256 aa0b046f37eed392a92a09f3492f3c131d85ba4959f0b2126c5e4f8c4bb51217

See more details on using hashes here.

File details

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

File metadata

  • Download URL: yonoma-0.1.2-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.2-py3-none-any.whl
Algorithm Hash digest
SHA256 7d4fb17ab7b6e6268915e54b0b5d97c6e6a432345f9e56886dda9166eb9f1626
MD5 189f6f32c3b9cd93dac38af1498cde09
BLAKE2b-256 a01f13344719b49fd8eb87a06fe6769882d3cdf56bad0e3df0951a35422c8c43

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