Save a private data value

Stores a private data value against your company under the given key. Private data is for storing secrets and any data that needs to be encrypted.

Treat these values as sensitive. Don't log them, and don't expose them to browsers or other client-side code.

Saving to a key that already exists replaces its value.

The key is the whole last part of the URL

Smooth POS stores the key exactly as it appears in the path, .json included, so courier_api_key.json is stored as courier_api_key.json. Always use the same URL to save, read and delete.

Needs the mycompany_update permission on your API user.

Required permission:

GroupPermission
AdminUpdate company details and settings (includes view)
Path Params
string
required

The key the value is stored under.

Body Params

The value to store, sent as the raw request body. Plain text or JSON both work. It's stored exactly as sent, encrypted.

Headers
string
enum
Defaults to application/json

Generated from available request content types

Allowed:
Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json