Config

Application configuration and settings

List Vars

get

Authorizations

OAuth2PasswordBearer

OAuth2passwordRequired

Token URL:

Responses

200

Successful Response

application/json

idintegerRequired

namestringRequired

kindstringRequired

valueany ofOptional

stringOptional

or

nullOptional

patternany ofOptional

stringOptional

or

nullOptional

tenant_guidany ofOptional

stringOptional

or

nullOptional

per_recipientbooleanOptionalDefault: false

get

/api/config/vars

HTTPcURLJavaScriptPython

GET /api/config/vars HTTP/1.1
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

200

Successful Response

[
  {
    "id": 1,
    "name": "text",
    "kind": "text",
    "value": "text",
    "pattern": "text",
    "tenant_guid": "text",
    "per_recipient": false
  }
]

Create Var

post

Authorizations

OAuth2PasswordBearer

OAuth2passwordRequired

Token URL:

Body

application/json

namestringRequired

kindstringRequired

valueany ofOptional

stringOptional

or

nullOptional

patternany ofOptional

stringOptional

or

nullOptional

tenant_guidany ofOptional

stringOptional

or

nullOptional

per_recipientany ofOptionalDefault: false

booleanOptional

or

nullOptional

Responses

200

Successful Response

application/json

idintegerRequired

namestringRequired

kindstringRequired

valueany ofOptional

stringOptional

or

nullOptional

patternany ofOptional

stringOptional

or

nullOptional

tenant_guidany ofOptional

stringOptional

or

nullOptional

per_recipientbooleanOptionalDefault: false

422

Validation Error

application/json

post

/api/config/vars

HTTPcURLJavaScriptPython

POST /api/config/vars HTTP/1.1
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 104

{
  "name": "text",
  "kind": "text",
  "value": "text",
  "pattern": "text",
  "tenant_guid": "text",
  "per_recipient": false
}

{
  "id": 1,
  "name": "text",
  "kind": "text",
  "value": "text",
  "pattern": "text",
  "tenant_guid": "text",
  "per_recipient": false
}

Update Var

put

Authorizations

OAuth2PasswordBearer

OAuth2passwordRequired

Token URL:

Path parameters

var_idintegerRequired

Body

application/json

namestringRequired

kindstringRequired

valueany ofOptional

stringOptional

or

nullOptional

patternany ofOptional

stringOptional

or

nullOptional

tenant_guidany ofOptional

stringOptional

or

nullOptional

per_recipientany ofOptionalDefault: false

booleanOptional

or

nullOptional

Responses

200

Successful Response

application/json

idintegerRequired

namestringRequired

kindstringRequired

valueany ofOptional

stringOptional

or

nullOptional

patternany ofOptional

stringOptional

or

nullOptional

tenant_guidany ofOptional

stringOptional

or

nullOptional

per_recipientbooleanOptionalDefault: false

422

Validation Error

application/json

put

/api/config/vars/{var_id}

HTTPcURLJavaScriptPython

PUT /api/config/vars/{var_id} HTTP/1.1
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 104

{
  "name": "text",
  "kind": "text",
  "value": "text",
  "pattern": "text",
  "tenant_guid": "text",
  "per_recipient": false
}

{
  "id": 1,
  "name": "text",
  "kind": "text",
  "value": "text",
  "pattern": "text",
  "tenant_guid": "text",
  "per_recipient": false
}

Delete Var

delete

Authorizations

OAuth2PasswordBearer

OAuth2passwordRequired

Token URL:

Path parameters

var_idintegerRequired

Responses

200

Successful Response

application/json

anyOptional

422

Validation Error

application/json

delete

/api/config/vars/{var_id}

HTTPcURLJavaScriptPython

DELETE /api/config/vars/{var_id} HTTP/1.1
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

No content

Get Settings

get

Authorizations

OAuth2PasswordBearer

OAuth2passwordRequired

Token URL:

Responses

200

Successful Response

application/json

get

/api/config/settings

HTTPcURLJavaScriptPython

GET /api/config/settings HTTP/1.1
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

200

Successful Response

{
  "values": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  }
}

Update Settings

put

Authorizations

OAuth2PasswordBearer

OAuth2passwordRequired

Token URL:

Body

application/json

Responses

200

Successful Response

application/json

422

Validation Error

application/json

put

/api/config/settings

HTTPcURLJavaScriptPython

PUT /api/config/settings HTTP/1.1
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 45

{
  "values": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  }
}

{
  "values": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  }
}

Resolve Tenant Guid

get

Authorizations

OAuth2PasswordBearer

OAuth2passwordRequired

Token URL:

Query parameters

domainstringRequired

Responses

200

Successful Response

application/json

anyOptional

422

Validation Error

application/json

get

/api/config/tenant_guid

HTTPcURLJavaScriptPython

GET /api/config/tenant_guid?domain=text HTTP/1.1
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

No content

Preview Var List

get

Authorizations

OAuth2PasswordBearer

OAuth2passwordRequired

Token URL:

Responses

200

Successful Response

application/json

anyOptional

get

/api/config/vars/preview

HTTPcURLJavaScriptPython

GET /api/config/vars/preview HTTP/1.1
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

200

Successful Response

No content