# Convirza API

**Canonical:** https://apis.io/apis/convirza/convirza-api/  
**Provider:** Convirza — https://apis.io/providers/convirza/  
**Base URL:** https://platform-oauth.convirza.com  
**Documentation:** https://docs.convirza.com/list-webhooks-31749922e0.md

Convirza API is published by [Convirza](https://apis.io/providers/convirza/) on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. This API exposes 6 JSON Schema definitions. The published artifact set on APIs.io includes an OpenAPI specification and 6 JSON Schemas.

Convirza API as documented publicly: 56 operations. Contract generated from the documentation by API Evangelist (2026-10-11); not the provider's own document.

## Operations (56)

| Method | Path | Summary |
|---|---|---|
| GET | `/ad-source` | Get ad source list |
| GET | `/ai-voice-agents` | List AI voice agents |
| POST | `/ai-voice-agents` | Create new voice agent |
| DELETE | `/ai-voice-agents/{id}` | Delete voice agent |
| GET | `/ai-voice-agents/{id}` | Get voice agent details |
| PATCH | `/ai-voice-agents/{id}` | Update voice agent (partial update) |
| PUT | `/ai-voice-agents/{id}` | Update voice agent (full update) |
| GET | `/broadcast` | List SMS broadcasts with filtering |
| POST | `/broadcast` | Create SMS broadcast campaign |
| DELETE | `/broadcast/{broadcastId}` | Cancel/delete broadcast |
| GET | `/broadcast/{broadcastId}` | Get broadcast details and status |
| PATCH | `/broadcast/{broadcastId}` | Update broadcast (partial update) |
| PUT | `/broadcast/{broadcastId}` | Update broadcast (full update) |
| GET | `/conversations/{conversationid}` | Get call conversation history |
| POST | `/groups` | Create a new group |
| DELETE | `/groups/{id}` | Delete group (soft delete) |
| GET | `/groups/{id}` | Get group details by ID |
| PATCH | `/groups/{id}` | Update group (partial update) |
| PUT | `/groups/{id}` | Update group (full update) |
| GET | `/groups/org-list/{ouid}` | Get organization hierarchy list |
| GET | `/industry` | Get industry list |
| GET | `/media-prompts` | List recordings with optional type filter |
| POST | `/media-prompts` | Upload audio recording file |
| DELETE | `/media-prompts/{id}` | Delete recording (soft delete) |
| GET | `/oauth/token` | GET /oauth/token |
| POST | `/oauth/token/client-credentials` | POST /oauth/token/client-credentials |
| POST | `/oauth/{oauthid}` | POST /oauth/refresh-token |
| DELETE | `/phone-numbers/number` | Release phone number |
| POST | `/phone-numbers/order` | Order new phone number |
| GET | `/phone-numbers/{phonenumberid}` | Get assigned phone numbers |
| GET | `/provisioned-routes` | List provisioned routes |
| POST | `/provisioned-routes` | Create new route |
| PATCH | `/provisioned-routes/{id}` | Update route (partial update) |
| PUT | `/provisioned-routes/{id}` | Update route (full update) |
| DELETE | `/provisioned-routes/{provisionedRouteId}` | Delete route |
| GET | `/provisioned-routes/{provisionedRouteId}` | Get route details |
| DELETE | `/tag` | Delete tag(s) |
| POST | `/tag` | Create new tag |
| PUT | `/tag` | Update tag |
| GET | `/tag/{orgUnitId}` | List tags for organization |
| POST | `/users` | Create a new user |
| DELETE | `/users/{id}` | Delete user (soft delete) |
| GET | `/users/{id}` | Get user details by ID |
| PATCH | `/users/{id}` | Update user (partial update) |
| PUT | `/users/{id}` | Update user (full update) |
| GET | `/v2/user/reports` | GET /v2/user/reports |
| POST | `/v3/conversations/calls/upload` | Call recording upload |
| GET | `/v3/conversations/{conversationid}` | Call data retrieval |
| GET | `/v3/users/list` | GET /v3/users/list |
| GET | `/v3/{v3id}` | Campaign data |
| POST | `/v3/{v3id}` | User management |
| POST | `/webhooks` | Create a new webhook subscription |
| DELETE | `/webhooks/{id}` | Delete webhook |
| GET | `/webhooks/{id}` | Get webhook details by ID |
| PATCH | `/webhooks/{id}` | Update webhook (partial update) |
| PUT | `/webhooks/{id}` | Update webhook (full update) |

## Machine-readable artifacts (8)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/convirza/refs/heads/main/openapi/_ae-authored/convirza-openapi-generated.yml
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/convirza/refs/heads/main/json-schema/convirza-post-oauth-token-client-credentials-response-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/convirza/refs/heads/main/json-schema/convirza-get-oauth-token-response-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/convirza/refs/heads/main/json-schema/convirza-post-media-prompts-request-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/convirza/refs/heads/main/json-schema/convirza-get-v2-user-reports-response-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/convirza/refs/heads/main/json-schema/convirza-post-oauth-token-client-credentials-request-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/convirza/refs/heads/main/json-schema/convirza-post-oauth-oauthid-request-schema.json
- **APIsJSON** — https://raw.githubusercontent.com/api-evangelist/convirza/refs/heads/main/apis.yml

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/convirza/convirza-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/convirza/.