Admin - API Endpoints

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

get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Responses
200

Successful Operation

application/json
get
/admin/contents/onboardings
post
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
namestringRequiredExample: Welcome App
enabledbooleanRequiredExample: false
typestring Β· enumRequiredExample: APP_ONBOARDINGPossible values:
Responses
post
/admin/contents/onboardings
get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Responses
200

Successful Operation

application/json
get
/admin/contents/onboardings/types
get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
slugstringRequired
Query parameters
includeSlidesbooleanRequired
Responses
200

Successful Operation

application/json
get
/admin/contents/onboardings/{slug}
delete
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
slugstringRequired
Responses
200

Successful Operation

application/json
ResponseanyExample: {"statusCode":200}
delete
/admin/contents/onboardings/{slug}
patch
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
slugstringRequired
Body
namestringOptionalExample: Welcome App
enabledbooleanOptionalExample: false
typestring Β· enumOptionalExample: APP_ONBOARDINGPossible values:
Responses
200

Successful Operation

application/json
ResponseanyExample: {"statusCode":200}
patch
/admin/contents/onboardings/{slug}
get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
slugstringRequired
Responses
200

Successful Operation

application/json
get
/admin/contents/onboardings/{slug}/slides
post
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
titlestringRequiredExample: Check Deposits
contentstringRequiredExample: Lorem Ipsum is simply dummy text of the printing and typesetting industry.
imagestringRequiredExample: https://dummyimage.com/300x300/000/fff
onboardingIdstringRequiredExample: c3d1d81d-2eb7-4c01-8a8d-904fd951a17d
Responses
post
/admin/contents/onboarding-slides
delete
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
idstringRequired
Responses
200

Successful Operation

application/json
ResponseanyExample: {"statusCode":200}
delete
/admin/contents/onboarding-slides/{id}
patch
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
idstringRequired
Body
titlestringOptionalExample: Check Deposits
contentstringOptionalExample: Lorem Ipsum is simply dummy text of the printing and typesetting industry.
imagestringOptionalExample: https://dummyimage.com/300x300/000/fff
indexnumberOptional

Through this field you can order the onboarding screens.

Example: 0
Responses
200

Successful Operation

application/json
ResponseanyExample: {"statusCode":200}
patch
/admin/contents/onboarding-slides/{id}
get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
typestringRequired
Query parameters
includeSlidesbooleanRequired
Responses
200

Successful Operation

application/json
get
/admin/contents/onboardings/types/{type}

Last updated

Was this helpful?