Dictionaries API

GET/v1/intents

List intents

Lists every intent in the organization, ordered by value.

GET https://api.simplyrcs.com/v1/intents · requires an API key

Responses

Example request

curl -X GET https://api.simplyrcs.com/v1/intents \
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/v1/intents

Create an intent

Creates a reusable postback intent. Returns 409 if the normalized value already exists for the organization.

POST https://api.simplyrcs.com/v1/intents · requires an API key

Request body

IntentCreateRequest · optional

Responses

Example request

curl -X POST https://api.simplyrcs.com/v1/intents \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{ "name": "Example request" }'

PATCH/v1/intents/{id}

Update an intent

Updates label, description, folder, or active state. The intent value (the postback token) is immutable after creation; attempting to change it returns 400 TOKEN_IMMUTABLE. Use the rewrite endpoint to rename a value across flows.

PATCH https://api.simplyrcs.com/v1/intents/{id} · requires an API key

Path parameters

Request body

IntentUpdateRequest · optional

Responses

Example request

curl -X PATCH https://api.simplyrcs.com/v1/intents/{id} \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{ "name": "Example request" }'

DELETE/v1/intents/{id}

Delete an intent

DELETE https://api.simplyrcs.com/v1/intents/{id} · requires an API key

Path parameters

Responses

Example request

curl -X DELETE https://api.simplyrcs.com/v1/intents/{id} \
  -H 'Authorization: Bearer YOUR_API_KEY'

GET/v1/intents/{id}/usage

Get intent usage

Where-used report: which bots and how many nodes reference this intent value across draft and published flows.

GET https://api.simplyrcs.com/v1/intents/{id}/usage · requires an API key

Path parameters

Responses

Example request

curl -X GET https://api.simplyrcs.com/v1/intents/{id}/usage \
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/v1/intents/{id}/rewrite

Rename an intent and rewrite flows

Renames the intent value and rewrites every flow reference atomically. Returns 409 if another intent already uses the new value.

POST https://api.simplyrcs.com/v1/intents/{id}/rewrite · requires an API key

Path parameters

Request body

IntentRewriteRequest · optional

Responses

Example request

curl -X POST https://api.simplyrcs.com/v1/intents/{id}/rewrite \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{ "name": "Example request" }'

GET/v1/variable-definitions

List variable definitions

Lists every variable definition in the organization, ordered by name.

GET https://api.simplyrcs.com/v1/variable-definitions · requires an API key

Responses

Example request

curl -X GET https://api.simplyrcs.com/v1/variable-definitions \
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/v1/variable-definitions

Create a variable definition

Creates a reusable data-capture variable. Returns 409 if the normalized name already exists for the organization.

POST https://api.simplyrcs.com/v1/variable-definitions · requires an API key

Request body

VariableDefinitionCreateRequest · optional

Responses

Example request

curl -X POST https://api.simplyrcs.com/v1/variable-definitions \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{ "name": "Example request" }'

PATCH/v1/variable-definitions/{id}

Update a variable definition

Updates editable fields. The variable name (the capture token) is immutable after creation; attempting to change it returns 400 TOKEN_IMMUTABLE. Switching type away from list clears items.

PATCH https://api.simplyrcs.com/v1/variable-definitions/{id} · requires an API key

Path parameters

Request body

VariableDefinitionUpdateRequest · optional

Responses

Example request

curl -X PATCH https://api.simplyrcs.com/v1/variable-definitions/{id} \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{ "name": "Example request" }'

DELETE/v1/variable-definitions/{id}

Delete a variable definition

DELETE https://api.simplyrcs.com/v1/variable-definitions/{id} · requires an API key

Path parameters

Responses

Example request

curl -X DELETE https://api.simplyrcs.com/v1/variable-definitions/{id} \
  -H 'Authorization: Bearer YOUR_API_KEY'

GET/v1/variable-definitions/{id}/usage

Get variable usage

Where-used report: which bots and how many nodes capture into this variable across draft and published flows.

GET https://api.simplyrcs.com/v1/variable-definitions/{id}/usage · requires an API key

Path parameters

Responses

Example request

curl -X GET https://api.simplyrcs.com/v1/variable-definitions/{id}/usage \
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/v1/variable-definitions/{id}/rewrite

Rename a variable and rewrite flows

Renames the variable and rewrites every data-capture node referencing it, atomically. Returns 409 if another variable already uses the new name.

POST https://api.simplyrcs.com/v1/variable-definitions/{id}/rewrite · requires an API key

Path parameters

Request body

VariableRewriteRequest · optional

Responses

Example request

curl -X POST https://api.simplyrcs.com/v1/variable-definitions/{id}/rewrite \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{ "name": "Example request" }'

GET/v1/dictionary-categories

List dictionary folders

Lists the org-wide folder taxonomy shared by the Intents and Variables dictionaries, ordered by sortOrder then name.

GET https://api.simplyrcs.com/v1/dictionary-categories · requires an API key

Responses

Example request

curl -X GET https://api.simplyrcs.com/v1/dictionary-categories \
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/v1/dictionary-categories

Create a dictionary folder

Creates a folder. New folders sort to the end unless sortOrder is supplied. Returns 409 on a duplicate name.

POST https://api.simplyrcs.com/v1/dictionary-categories · requires an API key

Request body

DictionaryCategoryCreateRequest · optional

Responses

Example request

curl -X POST https://api.simplyrcs.com/v1/dictionary-categories \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{ "name": "Example request" }'

PATCH/v1/dictionary-categories/{id}

Update a dictionary folder

PATCH https://api.simplyrcs.com/v1/dictionary-categories/{id} · requires an API key

Path parameters

Request body

DictionaryCategoryUpdateRequest · optional

Responses

Example request

curl -X PATCH https://api.simplyrcs.com/v1/dictionary-categories/{id} \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{ "name": "Example request" }'

DELETE/v1/dictionary-categories/{id}

Delete a dictionary folder

Deletes the folder and un-files its intents and variables (sets their categoryId to null). Never deletes the dictionary entries themselves.

DELETE https://api.simplyrcs.com/v1/dictionary-categories/{id} · requires an API key

Path parameters

Responses

Example request

curl -X DELETE https://api.simplyrcs.com/v1/dictionary-categories/{id} \
  -H 'Authorization: Bearer YOUR_API_KEY'

POST/v1/dictionary-categories/reorder

Reorder dictionary folders

Persists a new ordering in one transaction: sortOrder is rewritten to the array index. Ids not belonging to the organization are ignored. Returns the full reordered list.

POST https://api.simplyrcs.com/v1/dictionary-categories/reorder · requires an API key

Request body

DictionaryCategoryReorderRequest · optional

Responses

Example request

curl -X POST https://api.simplyrcs.com/v1/dictionary-categories/reorder \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{ "name": "Example request" }'