canonical: https://jentic.com/apis/sprinklr.com/sprinklr

# Sprinklr API

Sprinklr is a unified customer experience management (Unified-CXM) platform. This specification covers core API categories including Messaging, Case Management, Publishing, Profile/Contact Management, and Webhooks. The API exposes 31 endpoints secured with apiKey, bearer authentication.

## For AI agents

Programmatically generate access token, refresh access token. Covers 31 operations with apiKey, bearer authentication.

## Scope

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

## Capabilities

- Generate access token
- Refresh access token
- Send a message
- Reply to a message
- Get message by ID
- Delete a message
- Search messages

## Use cases

### CRM Operations

Use the Sprinklr API to perform crm operations programmatically. The API provides 31 endpoints covering core functionality including generate access token, refresh access token, send a message.

Example prompt: Call POST `/oauth/token` to generate access token

### Automated Authentication Management

Automate authentication operations by combining multiple Sprinklr API endpoints. Agents can refresh access token and then send a message in a single workflow.

Example prompt: Call POST `/oauth/token/refresh` to refresh access token, then verify the result

### AI Agent Integration via Jentic

AI agents discover and call Sprinklr 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, bearer tokens manually.

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

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| POST | `/oauth/token` | Generate access token |
| POST | `/oauth/token/refresh` | Refresh access token |
| POST | `/message` | Send a message |
| POST | `/message/reply` | Reply to a message |
| GET | `/message/{messageId}` | Get message by ID |
| DELETE | `/message/{messageId}` | Delete a message |
| POST | `/message/search` | Search messages |
| POST | `/case` | Create a case |

## Key resources

- **Authentication** — OAuth 2.0 token management
- **Messaging** — Send and receive messages across social and messaging channels
- **Case Management** — Create, update, and query support cases
- **Publishing** — Schedule and publish content to social channels
- **Profile Management** — Manage customer profiles and contacts

## 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:** 69 / 100
- **Maturity:** AI-Aware
- **Dimensions:**
  - Foundational Compliance: 99 / 100
  - Developer Experience & Jentic Compatibility: 62 / 100
  - AI-Readiness & Agent Experience: 51 / 100
  - Agent Usability: 94 / 100
  - Security: 63 / 100
  - AI Discoverability: 81 / 100
- **View full report:** https://jentic.com/apis/sprinklr.com/sprinklr/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 Sprinklr API by hand means handling its API key header plus a JWT bearer token minted from `/oauth/token`, refreshing that token, and pointing every call at the api2.sprinklr.com/api/v2 host yourself. Through Jentic you install once, import the Sprinklr API from the API Directory, store the credential once, and your agent calls it.
- **Permission scoping:** Sprinklr puts the message id in the URL path (`/message/{messageId}`), so a rule can pin your agent to reading one message. You choose the operations it may call, so destructive ones like deleting a message are not included unless you add them.
- **Credential handling:** Your Sprinklr 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 'search messages' or 'create a case', and Jentic returns the matching Sprinklr API operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Hubspot** — Alternative crm API
- **Salesforce** — Alternative crm API
- **Pipedrive** — Complementary crm API
- **Zoho** — Complementary crm API

## FAQ

### What authentication does the Sprinklr API use?

The Sprinklr API uses apiKey, bearer authentication. 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 generate access token with the Sprinklr API?

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

### What are the rate limits for the Sprinklr 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 generate access token through Jentic?

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

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

The Sprinklr API exposes 31 endpoints covering authentication, messaging, case management operations.

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

Yes. Because Jentic One is self-hosted, you write the rules that decide which Sprinklr operations and credentials your agent may use. You choose the exact endpoints it can call, so destructive ones like DELETE `/message/{messageId}` stay out unless you add them, while it can still send or search messages and create cases. Since Sprinklr puts the message id in the URL path (`/message/{messageId}`), a rule can even pin the agent to reading a single message.