Admin - API Endpoints

To use the following endpoints, you must have the role of administrator or super administrator.

PreviousDB Schema NextClient - API Endpoints

Last updated 1 year ago

Was this helpful?

get

/admin/contents/onboardings

Authorizations

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/admin/contents/onboardings' \
  --header 'Authorization: Bearer JWT'

200

401

403

404

{
  "statusCode": 200,
  "data": {
    "onboardings": [
      {
        "id": "c3d1d81d-2eb7-4c01-8a8d-904fd951a17d",
        "name": "Onboarding App",
        "slug": "onboarding-app",
        "type": "APP_ONBOARDING",
        "enabled": true
      }
    ]
  }
}

Successful Operation

post

/admin/contents/onboardings

Authorizations

Body

namestringrequired

Example: Welcome App

enabledbooleanrequired

Example: false

typestring · enumrequired

Example: APP_ONBOARDING

Options: APP_ONBOARDING, MARKETING_ONBOARDING

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/admin/contents/onboardings' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{"name":"Welcome App","enabled":false,"type":"APP_ONBOARDING"}'

201

400

401

403

404

{
  "statusCode": 201
}

Successful Operation

get

/admin/contents/onboardings/types

Authorizations

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/admin/contents/onboardings/types' \
  --header 'Authorization: Bearer JWT'

200

401

403

404

{
  "statusCode": 200,
  "data": {
    "types": [
      "APP_ONBOARDING"
    ]
  }
}

Successful Operation

get

/admin/contents/onboardings/{slug}

Authorizations

Path parameters

slugstringrequired

Query parameters

includeSlidesbooleanrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/admin/contents/onboardings/{slug}?includeSlides=true' \
  --header 'Authorization: Bearer JWT'

200

401

403

404

{
  "statusCode": 200,
  "data": {
    "id": "c3d1d81d-2eb7-4c01-8a8d-904fd951a17d",
    "name": "Onboarding App",
    "slug": "onboarding-app",
    "type": "APP_ONBOARDING",
    "enabled": true,
    "onboardingSlides": [
      {
        "id": "c3d1d81d-2eb7-4c01-8a8d-904fd9dqwkl32",
        "title": "Title 1",
        "content": "Lorem Ipsum is simply dummy text of the printing and typesetting industry",
        "index": 0,
        "image": "https://dummyimage.com/300x300/000/fff",
        "onboardingId": "c3d1d81d-2eb7-4c01-8a8d-904fd951a17d"
      }
    ]
  }
}

Successful Operation

delete

/admin/contents/onboardings/{slug}

Authorizations

Path parameters

slugstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url '/admin/contents/onboardings/{slug}' \
  --header 'Authorization: Bearer JWT'

200

400

401

403

404

{
  "statusCode": 200
}

Successful Operation

patch

/admin/contents/onboardings/{slug}

Authorizations

Path parameters

slugstringrequired

Body

namestring

Example: Welcome App

enabledboolean

Example: false

typestring · enum

Example: APP_ONBOARDING

Options: APP_ONBOARDING, MARKETING_ONBOARDING

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PATCH \
  --url '/admin/contents/onboardings/{slug}' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{"name":"Welcome App","enabled":false,"type":"APP_ONBOARDING"}'

200

400

401

403

404

{
  "statusCode": 200
}

Successful Operation

get

/admin/contents/onboardings/{slug}/slides

Authorizations

Path parameters

slugstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/admin/contents/onboardings/{slug}/slides' \
  --header 'Authorization: Bearer JWT'

200

400

401

403

404

{
  "statusCode": 200,
  "data": {
    "slides": [
      {
        "id": "c3d1d81d-2eb7-4c01-8a8d-904fd9dqwkl32",
        "title": "Title 1",
        "content": "Lorem Ipsum is simply dummy text of the printing and typesetting industry",
        "index": 0,
        "image": "https://dummyimage.com/300x300/000/fff",
        "onboardingId": "c3d1d81d-2eb7-4c01-8a8d-904fd951a17d"
      }
    ]
  }
}

Successful Operation

post

/admin/contents/onboarding-slides

Authorizations

Body

titlestringrequired

Example: Check Deposits

contentstringrequired

Example: Lorem Ipsum is simply dummy text of the printing and typesetting industry.

imagestringrequired

Example: https://dummyimage.com/300x300/000/fff

onboardingIdstringrequired

Example: c3d1d81d-2eb7-4c01-8a8d-904fd951a17d

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/admin/contents/onboarding-slides' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{"title":"Check Deposits","content":"Lorem Ipsum is simply dummy text of the printing and typesetting industry.","image":"https://dummyimage.com/300x300/000/fff","onboardingId":"c3d1d81d-2eb7-4c01-8a8d-904fd951a17d"}'

201

400

401

403

404

{
  "statusCode": 201
}

Successful Operation

delete

/admin/contents/onboarding-slides/{id}

Authorizations

Path parameters

idstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url '/admin/contents/onboarding-slides/{id}' \
  --header 'Authorization: Bearer JWT'

200

400

401

403

404

{
  "statusCode": 200
}

Successful Operation

patch

/admin/contents/onboarding-slides/{id}

Authorizations

Path parameters

idstringrequired

Body

titlestring

Example: Check Deposits

contentstring

Example: Lorem Ipsum is simply dummy text of the printing and typesetting industry.

imagestring

Example: https://dummyimage.com/300x300/000/fff

indexnumber

Through this field you can order the onboarding screens.

Example: 0

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PATCH \
  --url '/admin/contents/onboarding-slides/{id}' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{"title":"Check Deposits","content":"Lorem Ipsum is simply dummy text of the printing and typesetting industry.","image":"https://dummyimage.com/300x300/000/fff","index":0}'

200

400

401

403

404

{
  "statusCode": 200
}

Successful Operation

get

/admin/contents/onboardings/types/{type}

Authorizations

Path parameters

typestringrequired

Query parameters

includeSlidesbooleanrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/admin/contents/onboardings/types/{type}?includeSlides=true' \
  --header 'Authorization: Bearer JWT'

200

401

403

404

{
  "statusCode": 200,
  "data": {
    "id": "c3d1d81d-2eb7-4c01-8a8d-904fd951a17d",
    "name": "Onboarding App",
    "slug": "onboarding-app",
    "type": "APP_ONBOARDING",
    "enabled": true,
    "onboardingSlides": [
      {
        "id": "c3d1d81d-2eb7-4c01-8a8d-904fd9dqwkl32",
        "title": "Title 1",
        "content": "Lorem Ipsum is simply dummy text of the printing and typesetting industry",
        "index": 0,
        "image": "https://dummyimage.com/300x300/000/fff",
        "onboardingId": "c3d1d81d-2eb7-4c01-8a8d-904fd951a17d"
      }
    ]
  }
}

Successful Operation