> ## Documentation Index > Fetch the complete documentation index at: https://docs.ya.works/llms.txt > Use this file to discover all available pages before exploring further. # Get template message status > Check where a template message got to, by your own `event_id`. ## OpenAPI ````yaml /openapi.json get /v1/template-messages/{event_id} openapi: 3.1.0 info: title: YV Business API description: >- Public API for YaVendio merchants to access orders, product catalog, conversations, contacts and company profile, and to send WhatsApp template messages. ## Authentication All endpoints require a valid API key sent via the `X-API-Key` header. API keys are created and managed from the [YaVendio Dashboard](https://ya.onl) under **Settings → API Keys**. Use the **Authorize** button above to set your key for all requests. Every endpoint declares the scope it requires (e.g. `orders:read`, `products:write`, `conversations:read`, `contacts:read`, `company:read`, `outbound:send`, `outbound:read`), listed on its reference page. Keys created from the dashboard today carry no scopes and therefore have full access; a key that has scopes but lacks the one an endpoint requires gets `403 Forbidden`. ## Rate Limiting Requests are rate-limited per merchant. Every response includes `X-RateLimit-Limit`, `X-RateLimit-Remaining`, and `X-RateLimit-Reset` headers. Check these headers to know your current limit and remaining quota. When the limit is exceeded, the API responds with `429 Too Many Requests` and adds a `Retry-After` header. ## Pagination List endpoints support pagination via `page` and `limit` query parameters. Responses include a `pagination` object with `total_pages`, `total_items`, and `has_more` fields. Maximum `limit` is 100. version: 1.14.2 servers: - url: https://api.ya.onl security: [] tags: - name: Orders description: Retrieve merchant orders and their details. - name: Products description: CRUD operations on merchant products. - name: Product Variants description: Manage variants of a product. - name: Product Options description: Manage product options. - name: Product Option Values description: Manage individual option values. - name: Product Media description: Manage media files attached to product variants. - name: Categories description: CRUD operations on merchant categories (tags). - name: Product Categories description: Assign and remove categories from products. - name: Catalogs description: Retrieve merchant catalogs. - name: Webhooks description: Manage webhook subscriptions for real-time order events. - name: Conversations description: Read WhatsApp conversations and their messages. - name: Contacts description: Retrieve campaign contacts. - name: Company description: Retrieve the merchant's company profile. - name: Templates description: >- List the WhatsApp templates approved for the merchant, with the variables each one expects. - name: Template Messages description: >- Send approved WhatsApp templates to customers and follow their delivery status. paths: /v1/template-messages/{event_id}: get: tags: - Template Messages summary: Get template message status description: Check where a template message got to, by your own `event_id`. operationId: get_template_message_v1_template_messages__event_id__get parameters: - name: event_id in: path required: true schema: type: string pattern: ^[A-Za-z0-9._-]{8,128}$ description: The `event_id` sent when the message was requested title: Event Id description: The `event_id` sent when the message was requested responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/TemplateMessageStatusResponse' headers: X-RateLimit-Limit: description: Maximum number of requests allowed in the current window schema: type: integer example: 100 X-RateLimit-Remaining: description: Number of requests remaining in the current window schema: type: integer example: 87 X-RateLimit-Reset: description: Unix timestamp when the rate limit window resets schema: type: integer example: 1710288000 '401': description: Invalid or missing API key content: application/json: schema: $ref: '#/components/schemas/APIErrorResponse' '403': description: API key lacks the `outbound:read` scope content: application/json: schema: $ref: '#/components/schemas/APIErrorResponse' '404': description: No template message with that `event_id` content: application/json: schema: $ref: '#/components/schemas/APIErrorResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' '429': description: Rate limit exceeded headers: X-RateLimit-Limit: description: Maximum number of requests allowed in the current window schema: type: integer example: 100 X-RateLimit-Remaining: description: Number of requests remaining in the current window schema: type: integer example: 87 X-RateLimit-Reset: description: Unix timestamp when the rate limit window resets schema: type: integer example: 1710288000 Retry-After: description: Seconds to wait before making another request schema: type: integer example: 30 content: application/json: schema: $ref: '#/components/schemas/APIErrorResponse' security: - APIKeyHeader: [] components: schemas: TemplateMessageStatusResponse: properties: event_id: type: string title: Event Id description: The `event_id` sent in the request status: $ref: '#/components/schemas/TemplateMessageStatus' description: >- Current status of the send. A send that was taken answers `accepted`; poll the status endpoint for what became of it. `sent`, `delivered`, `read` and `failed` come from delivery receipts, and `discarded` means it was never sent status_detail: anyOf: - type: string - type: 'null' title: Status Detail description: >- Reason behind a `failed` or `discarded` status, or the `delivery_not_observable` note on an `accepted` one. **Not a closed set, and may be absent.** `stale`, `paused`, `account_not_eligible`, `no_sender_number`, `send_failed`, `send_cancelled` and `delivery_not_observable` are ours and stable — the last one means the send went to a store this deployment cannot read, so the status will not settle here; when the provider refused the delivery it carries `provider_error_` with the provider's own numeric code (for example `provider_error_131049`), and that catalogue changes without notice. Branch on `status`, log this, and treat an unrecognised or missing value as a generic failure examples: - stale - provider_error_131049 updated_at: type: string format: date-time title: Updated At description: >- When this send's record last changed (UTC) — not when you asked. Polling never moves it, but a delivery write that leaves `status` unchanged does, so it is not a watermark: reconcile on `event_id` type: object required: - event_id - status - updated_at title: TemplateMessageStatusResponse APIErrorResponse: properties: type: type: string title: Type description: Error type identifier, e.g. 'UnauthorizedError' detail: type: string title: Detail description: Human-readable error message type: object required: - type - detail title: APIErrorResponse HTTPValidationError: properties: detail: items: $ref: '#/components/schemas/ValidationError' type: array title: Detail type: object title: HTTPValidationError TemplateMessageStatus: type: string enum: - accepted - in_progress - sent - delivered - read - failed - discarded title: TemplateMessageStatus ValidationError: properties: loc: items: anyOf: - type: string - type: integer type: array title: Location msg: type: string title: Message type: type: string title: Error Type input: title: Input ctx: type: object title: Context type: object required: - loc - msg - type title: ValidationError securitySchemes: APIKeyHeader: type: apiKey description: Merchant API key for authentication in: header name: X-API-Key ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.