arrow_back Back to all endpoints
POST https://test-api.finerworks.com/v3/add_update_app_key

Add / Update App Keys

Creates a new app_key for your account, or updates an existing app_key's name, description, and live/test mode when an app_key is provided.

Body

Name Description Type Additional information
id Id of app. Leave id blank or as 0 if creating a new one. number None.
app_key Unique identifier. Leave as null if creating new globally unique identifier None.
name Name of app text

Required

Max length: 50

description Optional description of app - 300 characters max text

Max length: 300

live If you want it to be live or in test mode. boolean None.
account_key Optional - User account associated with the request. Note, this will only be accepted for accounts with permission to utilize this parameter, otherwise it will be ignored and the request will based upon the user's api credentials. Leave as null if not authorized to use this parameter. text None.

Example JSON Body

application/json, text/json

{
  "id": 1,
  "app_key": "fee3cb79-592b-4b06-bc54-2141878c061f",
  "name": "sample string 2",
  "description": "sample string 3",
  "live": true,
  "account_key": "sample string 5"
}

Sample Code Library

curl --location --request POST 'https://test-api.finerworks.com/v3/add_update_app_key' \
--header 'Content-Type: application/json' \
--header 'web_api_key: my-web-api-key-goes-here' \
--header 'app_key: my-app-key-goes-here' \
--data-raw '{
  "id": 1,
  "app_key": "fee3cb79-592b-4b06-bc54-2141878c061f",
  "name": "sample string 2",
  "description": "sample string 3",
  "live": true,
  "account_key": "sample string 5"
}'