Skip to main content
POST
/
back-office
/
onboard
/
service-types
Create Service Type
curl --request POST \
  --url https://api.example.com/back-office/onboard/service-types \
  --header 'Content-Type: application/json' \
  --data '
{
  "code": "<string>",
  "name": "<string>",
  "url": "<string>",
  "description": "<string>",
  "configurationSchema": {}
}
'
{
  "data": {
    "code": "<string>",
    "name": "<string>",
    "id": "<string>",
    "createdAt": "<string>",
    "updatedAt": "<string>",
    "url": "<string>",
    "description": "<string>",
    "configurationSchema": {}
  },
  "code": "health_status_ok",
  "message": "<string>"
}

Body

application/json

Create service type request body

​
code
string
required
Minimum string length: 1
​
name
string
required
Minimum string length: 1
​
url
string<uri>
​
description
string
​
configurationSchema
object

Response

Successfully created service type

​
data
object
required
​
code
enum<string>
Available options:
health_status_ok,
health_status_error,
validation_error,
bad_request,
unauthorized,
forbidden,
not_found,
method_not_allowed,
internal_server_error,
organization_not_found,
cannot_access_organization,
api_key_not_found,
resource_already_exists
​
message
string