Change the Akronym default word
The Akronym API changes a user’s default word.
POST https://wikipcdia.org/api/change_wordUse the hostname wikipcdia.org exactly as shown.
Authentication
Section titled “Authentication”You need both credentials:
| Credential | Where to send it |
|---|---|
| Organization API key | Authorization: Bearer YOUR_ORGANIZATION_API_KEY header |
| User key | user_key field in the JSON request body |
Keep credentials private. Make requests from code you control securely; do not embed an organization API key in publicly served browser code or commit keys to source control.
Request an organization API key
Section titled “Request an organization API key”Organization API keys are provided to developers upon request. Contact us at contact@conjuringlab.com with a brief description of your integration.
Request an organization API key
This opens your email app with the recipient, subject, and message template filled in. Add your details and send the request.
Get the user key
Section titled “Get the user key”Users can generate their Akronym key under Settings → Integrations & add-ons → Connect other apps.
Headers
Section titled “Headers”| Header | Required | Value |
|---|---|---|
Content-Type |
Yes | application/json |
Authorization |
Yes | Bearer YOUR_ORGANIZATION_API_KEY |
Use the exact Bearer prefix, including capitalization and the space.
Request body
Section titled “Request body”{ "word": "abracadabra", "user_key": "USER_KEY"}| Field | Type | Required | Description |
|---|---|---|---|
word |
string | Yes | The new word, between 1 and 100 Unicode characters after normalization. |
user_key |
string | Yes | The unique user key used for authentication. |
Unknown JSON fields are rejected.
Word normalization
Section titled “Word normalization”Before validation and saving, the API lowercases the word and removes spaces, digits, punctuation, and unsupported characters. Supported accented letters are preserved; other letters are simplified where possible, including ß → ss, œ → oe, and æ → ae.
| Input | Saved word |
|---|---|
Crème brûlée! 42 |
crèmebrûlée |
Straße |
strasse |
MAÑANA ÄPFEL |
mananaapfel |
The 100-character limit applies to the normalized word. If normalization leaves an empty word, the request fails with 400 and missing required fields.
Send a request
Section titled “Send a request”Replace both key placeholders with valid credentials. This request sets the user’s default word to abracadabra.
curl -i -X POST 'https://wikipcdia.org/api/change_word' \ -H 'Content-Type: application/json' \ -H 'Authorization: Bearer YOUR_ORGANIZATION_API_KEY' \ -d '{ "word": "abracadabra", "user_key": "USER_KEY" }'The -i option includes response headers so you can inspect the HTTP status alongside the response body.
Response handling
Section titled “Response handling”Success
Section titled “Success”The API returns 200 OK with Content-Type: application/json:
{ "status": "success", "message": "Word changed successfully"}Success means the normalized word has been saved as the user’s default word.
The response does not include the saved word or a request ID.
Errors
Section titled “Errors”Errors from the API handler use the same JSON structure, with status set to error:
{ "status": "error", "message": "invalid user key"}| HTTP status | Exact message |
Meaning |
|---|---|---|
400 |
invalid request format |
The body could not be decoded, a field has the wrong type, or an unknown field was included. |
400 |
missing required fields |
user_key is empty or missing, or word is empty after normalization. |
400 |
word exceeds maximum length |
The normalized word contains more than 100 Unicode characters. |
400 |
user key exceeds maximum length |
The user key exceeds 256 UTF-8 bytes. |
400 |
invalid user key format |
The user key contains characters other than letters, numbers, hyphens, or underscores. |
401 |
no API key provided |
The Authorization header is missing or empty. |
401 |
invalid authorization format |
The header does not start with the exact Bearer prefix. |
401 |
invalid API key format |
The organization key is empty, exceeds 256 UTF-8 bytes, or contains invalid characters. |
401 |
invalid API key |
The organization key was not found, or its lookup failed. |
401 |
invalid user key |
The user key was not found, or its lookup failed. |
401 |
error changing default word |
The default word could not be updated. |
415 |
Content-Type must be application/json |
The Content-Type header is missing or does not identify JSON. |
Handle empty or non-JSON responses before parsing the body. Our bot filter can return 403 with an empty body. Only POST requests reach this API handler.
Retries
Section titled “Retries”Each repeated request applies the update again. If a connection fails before you receive a response, the update may already have succeeded. Retry only if you still want to set that word, since a retry can overwrite a more recent change.