ERerply
v1

Delete

Delete will delete the configuration by strict match of the following fields: level, application, levelID, type and name.

delete/configuration

Request

  • Base URL
    (relative, and it does not resolve against the document’s source URL)
  • Auth
    • API key in header sessionKey
    • or API key in header clientCode
    • or API key in header hmac-auth
    • or API key in header jwt
  • TypeScript
    A function with typed inputs. Its response is checked against the schema.

Query parameters

applicationstring required

Application (s) name that uses CAFA to store configs

levelstring

Level is the operating level where the config is stored. Has to be one of Company, Warehouse, Pos, User

level_idstring

LevelID is an unique value, used to identify the instance of the level. for User level, user id, for Pos - Point of Sale ID. Warehouse can use any unique string to identify the instance of its level, Company level does not need level_id.

typestring

Type is an optional grouping property, in this case its 'payment', indicating that this configuration belongs to payment integrations group used to query groups of related configurations

namestring

Name of the configuration

Headers

timestampstring

UNIX timestamp used for the HMAC Auth method only

Response

OK

idinteger
messagestring
statusCodestring

Changes

No recorded changes to this operation across all 1 revision of this API.