> ## Documentation Index > Fetch the complete documentation index at: https://help.ciarem.ai/llms.txt > Use this file to discover all available pages before exploring further. # Get a template's send requirements > What must be supplied to send this template, and whether it can be sent. Registered before `/templates/{template_id}` is irrelevant here (the literal segment makes the path distinct), but it is deliberately a sub-resource of the template rather than a query flag: it answers a different question and its shape has nothing in common with `PublicTemplate`. ## OpenAPI ````yaml /api-reference/openapi.json get /v1/templates/{template_id}/send-requirements openapi: 3.1.0 info: title: Ciarem API version: v1 description: > The Ciarem public API. Authenticate every request with an org-bound API key (created in Settings → API keys; Scale plan or free trial) sent as a bearer token: `Authorization: Bearer oak_…`. Compatibility: this is an early, fast-moving API. Most changes are additive (new endpoints, new optional params, new response fields, new enum/string values) — clients must tolerate unknown fields and unknown string values. Every contract change is listed in the changelog at help.ciarem.ai. servers: - url: https://api.ciarem.ai security: - apiKey: [] tags: - name: Account description: The organization behind the API key. - name: Contacts description: People in the CRM — create, read, update, delete. - name: CRM description: 'The shape of the CRM: custom properties and funnel stages.' - name: Conversations description: Read the message history of a conversation. - name: WhatsApp numbers description: The connected numbers a send can go out from. - name: WhatsApp templates description: Message templates, and what each one needs filled before it can be sent. - name: Broadcasts description: Send a template, and follow what happened to every recipient. paths: /v1/templates/{template_id}/send-requirements: get: tags: - WhatsApp templates summary: Get a template's send requirements description: >- What must be supplied to send this template, and whether it can be sent. Registered before `/templates/{template_id}` is irrelevant here (the literal segment makes the path distinct), but it is deliberately a sub-resource of the template rather than a query flag: it answers a different question and its shape has nothing in common with `PublicTemplate`. operationId: >- send_requirements_endpoint_v1_templates__template_id__send_requirements_get parameters: - name: template_id in: path required: true schema: type: string title: Template Id responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/PublicSendRequirements' headers: X-RateLimit-Limit: $ref: '#/components/headers/X-RateLimit-Limit' X-RateLimit-Remaining: $ref: '#/components/headers/X-RateLimit-Remaining' X-RateLimit-Reset: $ref: '#/components/headers/X-RateLimit-Reset' '401': description: >- No usable credential: `missing_bearer_token` (no `Authorization: Bearer`) or `invalid_api_key` (unknown or revoked key). content: application/json: schema: $ref: '#/components/schemas/PublicError' '403': description: >- The credential is real but not allowed here: `api_key_required` (a session token rather than an `oak_` key), `scale_plan_required` (a live plan below Scale — upgrade to Scale), `trial_expired` (the free trial ended without a card — subscribe to keep the key working), or `subscription_required` (the subscription is canceled or suspended). content: application/json: schema: $ref: '#/components/schemas/PublicError' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' '429': description: >- Over the organization's request budget (`rate_limited`). `Retry-After` says how many seconds to wait. content: application/json: schema: $ref: '#/components/schemas/PublicError' headers: Retry-After: description: Seconds until the window resets. schema: type: integer X-RateLimit-Limit: $ref: '#/components/headers/X-RateLimit-Limit' X-RateLimit-Remaining: $ref: '#/components/headers/X-RateLimit-Remaining' X-RateLimit-Reset: $ref: '#/components/headers/X-RateLimit-Reset' components: schemas: PublicSendRequirements: properties: variables: items: type: string type: array title: Variables contact_paths: items: type: string type: array title: Contact Paths catalog_slots: items: type: string type: array title: Catalog Slots needs_coupon: type: boolean title: Needs Coupon dynamic_url_buttons: items: $ref: '#/components/schemas/PublicUrlButton' type: array title: Dynamic Url Buttons needs_lto_expiration: type: boolean title: Needs Lto Expiration media_surfaces: items: $ref: '#/components/schemas/PublicMediaSurface' type: array title: Media Surfaces unsendable_reason: anyOf: - type: string - type: 'null' title: Unsendable Reason type: object required: - variables - contact_paths - catalog_slots - needs_coupon - dynamic_url_buttons - needs_lto_expiration - media_surfaces - unsendable_reason title: PublicSendRequirements description: >- What a template needs supplied before it can be sent. The public template's `components` cannot answer this on its own: the projection strips our private media/catalog keys, and Meta's `example.header_handle` looks like a usable default but is a link Meta's own fetcher refuses. This endpoint is the supported way to find out. PublicError: description: An error whose `detail` is a stable, machine-readable code. properties: detail: title: Detail type: string required: - detail title: PublicError type: object HTTPValidationError: properties: detail: items: $ref: '#/components/schemas/ValidationError' type: array title: Detail type: object title: HTTPValidationError PublicUrlButton: properties: index: type: integer title: Index text: type: string title: Text url_prefix: type: string title: Url Prefix type: object required: - index - text - url_prefix title: PublicUrlButton description: >- A URL button whose approved url carries a variable. `index` is the button's position in the WHOLE buttons array (Meta validates type and order against the approved template), not among the dynamic ones. PublicMediaSurface: properties: card: anyOf: - type: integer - type: 'null' title: Card format: type: string title: Format catalog_bound: type: boolean title: Catalog Bound type: object required: - card - format - catalog_bound title: PublicMediaSurface description: |- A header needing an asset. `card` is null for the template's own header, else the 0-based carousel card index. 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 headers: X-RateLimit-Limit: description: Requests allowed per window, shared across the org's keys. schema: type: integer X-RateLimit-Remaining: description: Requests left in the current window. schema: type: integer X-RateLimit-Reset: description: When the window resets, as a Unix timestamp in seconds. schema: type: integer securitySchemes: apiKey: type: http scheme: bearer description: 'An org API key: `Authorization: Bearer oak_…`.' ````