API - Administrator

PreviousDevice App Versions NextAPI - Client

Last updated 2 years ago

Was this helpful?

get

/admin/device-app-versions

Authorizations

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/admin/device-app-versions' \
  --header 'Authorization: Bearer JWT'

200

401

403

422

{
  "statusCode": 200,
  "data": {
    "appVersions": [
      {
        "device": "ANDROID",
        "version": "1"
      }
    ]
  }
}

Successful Operation

post

/admin/device-app-versions

Authorizations

Body

versionstring · 0.0.0required

Example: 1.0.0

iconstringrequired

Example: myUrlIcon

titlestringrequired

Example: Title 1

messagestringrequired

Example: loremp ipsum

actionLinkstringrequired

Example: myActionLink

isMinimumVersionbooleanrequired

Example: true

devicestring · enumrequired

Example: IOS

Options: IOS, ANDROID

iconTypestring · enumrequired

Example: IMAGE

Options: URL, IMAGE, LOTTIE

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/admin/device-app-versions' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{"version":"1.0.0","icon":"myUrlIcon","title":"Title 1","message":"loremp ipsum","actionLink":"myActionLink","isMinimumVersion":true,"device":"IOS","iconType":"IMAGE"}'

201

400

401

403

422

{
  "statusCode": 201
}

Successful Operation

get

/admin/device-app-versions/history

Authorizations

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/admin/device-app-versions/history' \
  --header 'Authorization: Bearer JWT'

200

401

403

422

{
  "statusCode": 200,
  "data": {
    "appVersions": [
      {
        "id": "7d484e87-d3ce-4139-ba5d-32c5225f0cc5",
        "device": "ANDROID",
        "version": "1.0.0",
        "createdAt": "2022-12-08 16:13:59.499068"
      }
    ]
  }
}

Successful Operation

get

/admin/device-app-versions/{device}

Authorizations

Path parameters

devicestring · enumrequired

Options: IOS, ANDROID

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/admin/device-app-versions/{device}' \
  --header 'Authorization: Bearer JWT'

200

401

403

404

422

{
  "statusCode": 200,
  "data": {
    "id": "7d484e87-d3ce-4139-ba5d-32c5225f0cc5",
    "version": "1.0.0",
    "actionLink": "myActionLinkUrl",
    "iconType": "IMAGE",
    "icon": "myIconUrl",
    "title": "Title 1",
    "AppMessage": "loremp ipsum",
    "createdAt": "2022-12-08 16:13:59.499068",
    "device": "ANDROID"
  }
}

Successful Operation

delete

/admin/device-app-versions/{id}

Authorizations

Path parameters

idstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url '/admin/device-app-versions/{id}' \
  --header 'Authorization: Bearer JWT'

200

400

401

403

422

{
  "statusCode": 200
}

Successful Operation

patch

/admin/device-app-versions/{id}

Authorizations

Path parameters

idstringrequired

Body

versionstring · 0.0.0

Example: 1.0.0

iconstring

Example: myUrlIcon

titlestring

Example: Title 1

messagestring

Example: loremp ipsum

actionLinkstring

Example: myActionLink

isMinimumVersionboolean

Example: true

devicestring · enum

Example: IOS

Options: IOS, ANDROID

iconTypestring · enum

Example: IMAGE

Options: URL, IMAGE, LOTTIE

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PATCH \
  --url '/admin/device-app-versions/{id}' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{"version":"1.0.0","icon":"myUrlIcon","title":"Title 1","message":"loremp ipsum","actionLink":"myActionLink","isMinimumVersion":true,"device":"IOS","iconType":"IMAGE"}'

200

400

401

403

422

{
  "statusCode": 200
}

Successful Operation