---
title: "Add an auto-response keyword to a virtual number"
method: POST
path: "/add-keyword/"
tags: ["Keywords"]
---

# Add an auto-response keyword to a virtual number

`POST /add-keyword/`

## Request

- Base URL: `http://api.smsfusion.com.au`
- URL: `http://api.smsfusion.com.au/add-keyword/`
- Auth: one of:
  - API key in query parameter `key`
  - HTTP basic

Keyword is uppercased, trimmed, and restricted to A-Z 0-9 hyphen; must be a single word of at most 20 characters after normalization. Reserved words (HELP plus the built-in unsubscribe/subscribe word lists) cannot be registered

## Query parameters

- `key` string, required

## Response `200`

Keyword added

- KeywordWriteResult
  - `success` boolean
  - `number` string
  - `keyword` string
  - `response` string

## Other responses

- `401`: FIELD_EMPTY or VALIDATION_FAILED (multi-word, over 20 chars, reserved word, response too long, or keyword already exists)
- `404`: Number not found or not owned
- `405`: Method not allowed - POST only

---

[API](https://skmtc.dev/smsfusion/apis/sms-fusion-api.md) · [All operations](https://skmtc.dev/smsfusion/apis/sms-fusion-api/llms.txt) · [OpenAPI document](https://skmtc.dev/smsfusion/apis/sms-fusion-api/revisions/a88b2793a6e9?raw)