canonical: https://jentic.com/apis/sendmsg.co.il/sendmsg-co-il

# Sendmsg API

Sendmsg is an all-in-one marketing platform for newsletters providing email automation, landing pages, SMS, digital courses and more. This API manages mailing lists, newsletters, SMS campaigns, user management, and analytics. The API exposes 26 endpoints secured with apiKey authentication.

## For AI agents

Programmatically get authentication token, test authentication. Covers 26 operations with apiKey authentication.

## Scope

Does not handle payments, communications, or crm - use for marketing only.

## Capabilities

- Get authentication token
- Test authentication
- Add or update users
- Query and filter Sendmsg API records by parameters
- Monitor Sendmsg API operational status and events

## Use cases

### Marketing Operations

Use the Sendmsg API to perform marketing operations programmatically. The API provides 26 endpoints covering core functionality including get authentication token, test authentication, add or update users.

Example prompt: Call POST /token to get authentication token

### Automated Authentication Management

Automate authentication operations by combining multiple Sendmsg API endpoints. Agents can test authentication and then add or update users in a single workflow.

Example prompt: Call POST /ping to test authentication, then verify the result

### AI Agent Integration via Jentic

AI agents discover and call Sendmsg API endpoints through Jentic without managing credentials directly. An agent searches for the required operation by intent, receives the matching endpoint schema, and executes the call with Jentic-managed authentication. This eliminates the need to read API documentation or handle apiKey tokens manually.

Example prompt: Search Jentic for 'get authentication token', load the operation schema, and execute with Jentic-managed credentials

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| POST | `/token` | Get authentication token |
| POST | `/ping` | Test authentication |
| POST | `/AddUsersOnly` | Add or update users |
| POST | `/AddUsersToLists` | Add users to mailing lists |
| GET | `/GetUserDetails/{userID}` | Get user details |
| GET | `/GetMailingListByID/{listID},{type}` | Get mailing list by ID |
| POST | `/GetSystemUsers` | Get system users by type |
| POST | `/ChangeUpdateStatus` | Change user status |

## Key resources

- **Authentication** — Authentication and token management
- **Users** — User management operations
- **Email Campaigns** — Email campaign and message operations
- **SMS Campaigns** — SMS campaign operations
- **Mailing Lists** — Mailing list management

## AI readiness

This API is usable in Jentic One now. Its AI-readiness score against Jentic's framework shows where it stands today and where improvements would make it even easier for agents to use.

- **Score:** 62 / 100
- **Maturity:** AI-Aware
- **Dimensions:**
  - Foundational Compliance: 87 / 100
  - Developer Experience & Jentic Compatibility: 57 / 100
  - AI-Readiness & Agent Experience: 47 / 100
  - Agent Usability: 94 / 100
  - Security: 50 / 100
  - AI Discoverability: 68 / 100
- **View full report:** https://jentic.com/apis/sendmsg.co.il/sendmsg-co-il/scorecard
- **How the score is calculated:** https://docs.jentic.com/reference/api-readiness-framework/overview/
- **More about the dimensions:** https://docs.jentic.com/reference/api-readiness-framework/specification/#dimensional-model-overview

### Score it yourself

Every API in the directory is allowlisted, so you can re-score it with no key required.

- **Score your own API:** https://jentic.com/scorecard.md
- **Scoring CLI agent skill:** https://github.com/jentic/jentic-api-scorecard/blob/main/skills/jentic-api-scorecard/SKILL.md

```sh
npx @jentic/api-scorecard-cli score <openapi-url>
```

## Why Jentic

- **Setup:** Wiring the Sendmsg API by hand means first calling its /token endpoint, then passing the returned token in the Authorization header on every request against gconvertrest.sendmsg.co.il/api/Sendmsg, and handling status codes yourself. Through Jentic you install once, import the Sendmsg API from the API Directory, store the credential once, and your agent calls it.
- **Permission scoping:** The Sendmsg API puts the user and list ids in the URL path (`/GetUserDetails/{userID}` and `/GetMailingListByID/{listID}`), so a rule can pin your agent to one user or mailing list. You choose the operations it may call, so ones that change state like updating a status are not included unless you add them.
- **Credential handling:** Your Sendmsg credential is stored once, encrypted, by your own Jentic One instance and injected at execution time. It never enters the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'add users to a mailing list', and Jentic returns the matching Sendmsg operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Mailchimp** — Alternative marketing API
- **Hubspot** — Alternative marketing API

## FAQ

### What authentication does the Sendmsg API use?

The Sendmsg API uses an API key passed in the `Authorization` header. Through Jentic, these credentials are stored encrypted in your Jentic One instance and injected at execution time, so raw secrets never enter the agent context.

### Can I get authentication token with the Sendmsg API?

Yes. Use the POST /token endpoint. The API returns structured JSON responses that agents can parse and act on directly.

### What are the rate limits for the Sendmsg API?

Rate limits are not specified in the OpenAPI spec. Check the vendor documentation for current limits. Through Jentic, rate limiting is handled automatically with retry logic built into the execution layer.

### How do I get authentication token through Jentic?

Install the Jentic SDK with pip install jentic, authenticate through Jentic One, the self-hosted execution layer, then search for 'get authentication token'. Jentic returns the matching Sendmsg API operation with its input schema. Load the schema and execute the call - credentials are injected automatically.

### How many endpoints does the Sendmsg API have?

The Sendmsg API exposes 26 endpoints covering authentication, users, email campaigns operations.

### Can I limit what my agent is allowed to do with the Sendmsg API?

Yes. Because you run Jentic One yourself, you decide which Sendmsg operations your agent may call and which stored credential it uses, so state-changing calls like ChangeUpdateStatus stay off unless you add them. The Sendmsg API carries the user and list ids in the URL path, as in `/GetUserDetails/{userID}` and `/GetMailingListByID/{listID}`, so your own rules can pin the agent to a single user or mailing list. This keeps the agent limited to read-only lookups such as GetUserDetails or a specific list while blocking anything you have not explicitly allowed.
