> For the complete documentation index, see [llms.txt](https://docs.taqnyat.sa/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.taqnyat.sa/api-reference/models.md).

# Models

## The TemplateMessageRequest object

```json
{"openapi":"3.0.3","info":{"title":"Taqnyat WhatsApp API - Send Templates","version":"2.0"},"components":{"schemas":{"TemplateMessageRequest":{"type":"object","required":["to","type","template"],"properties":{"messaging_product":{"type":"string","description":"Included by template types such as Media Carousel."},"to":{"type":"string","description":"Recipient identifier. Use an international phone number for\nphone-number sending or a WhatsApp user ID / BSUID for user-ID sending.\n"},"type":{"type":"string","enum":["template"]},"template":{"type":"object","required":["name","language"],"properties":{"name":{"type":"string","description":"Approved template name."},"language":{"type":"object","required":["code"],"properties":{"code":{"type":"string","description":"Approved template language code."}}},"components":{"type":"array","description":"Some template types, including the supplied OTP and Media Carousel\nexamples, place their components inside the template object.\n","items":{"type":"object","additionalProperties":true}}}},"components":{"type":"array","description":"Template parameters and media components supplied at send time.\n","items":{"type":"object","additionalProperties":true}},"sms":{"type":"object","description":"SMS fallback configuration when applicable.","additionalProperties":true}}}}}}
```

## The TemplateMessageResponse object

```json
{"openapi":"3.0.3","info":{"title":"Taqnyat WhatsApp API - Send Templates","version":"2.0"},"components":{"schemas":{"TemplateMessageResponse":{"oneOf":[{"$ref":"#/components/schemas/WhatsAppArrayStatusResponse"},{"$ref":"#/components/schemas/TemplateObjectStatusResponse"}]},"WhatsAppArrayStatusResponse":{"type":"object","properties":{"type":{"type":"string"},"statuses":{"type":"array","items":{"type":"object","properties":{"message_id":{"type":"string"},"recipient":{"type":"string"}}}}}},"TemplateObjectStatusResponse":{"type":"object","properties":{"type":{"type":"string"},"statuses":{"type":"object","properties":{"message_id":{"type":"string"},"recipient":{"type":"string"}}}}}}}}
```

## The WhatsAppArrayStatusResponse object

```json
{"openapi":"3.0.3","info":{"title":"Taqnyat WhatsApp API - Send Templates","version":"2.0"},"components":{"schemas":{"WhatsAppArrayStatusResponse":{"type":"object","properties":{"type":{"type":"string"},"statuses":{"type":"array","items":{"type":"object","properties":{"message_id":{"type":"string"},"recipient":{"type":"string"}}}}}}}}}
```

## The TemplateObjectStatusResponse object

```json
{"openapi":"3.0.3","info":{"title":"Taqnyat WhatsApp API - Send Templates","version":"2.0"},"components":{"schemas":{"TemplateObjectStatusResponse":{"type":"object","properties":{"type":{"type":"string"},"statuses":{"type":"object","properties":{"message_id":{"type":"string"},"recipient":{"type":"string"}}}}}}}}
```

## The ErrorResponse object

```json
{"openapi":"3.0.3","info":{"title":"Taqnyat WhatsApp API - Send Templates","version":"2.0"},"components":{"schemas":{"ErrorResponse":{"type":"object","properties":{"message":{"type":"string"},"reason":{"type":"string"}}}}}}
```