---
title: "Check Keyword Availability"
method: POST
path: "/i1/processes/users-by-keyword"
tags: ["Processes"]
---

# Check Keyword Availability

`POST /i1/processes/users-by-keyword`

## Request body

- KeywordValidation
  - `keyword` string, required — Word that people text to an SMS short or long code using their mobile phone.
  - `origin` string, required — <p><b><i>Required.</i></b> Specifies the Shortcode (from 1 to 6 digits), Longcode (from 7 digits on), an alphanumeric shortcode (ex. COMPANY) or a virtual number that will be used to originate and send the MO message.</p> <p><i>If you don't have one assigned yet please contact our support team to request one.</i></p>
  - `connection` string — <i>Optional.</i> Name of the Connection associated with the keyword being validated. All origin is related to a connection.

## Response `200`

Successful Operation

- SimpleItemsResponse
  - `meta` MetadataDTO
    - `timestamp` integer, required — Transaction's date in timestamp
    - `transactionId` string, required — Id for the current transaction (Endpoint's call)
    - `explain` string — Explain string in case of failure
  - `items` string[] — Array of items.

## Other responses

- `401` — User not allowed
- `500` — Internal Server Error

---

[API](https://skmtc.net/messangi/apis/raven.md) · [All operations](https://skmtc.net/messangi/apis/raven/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/messangi/raven/versions/c87f398fa338/schema)