Create a Service Category

POST

/businesses/{businessId}/service-categories

curl --request POST \
  --url https://api.upvio.com/v1/businesses/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/service-categories \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "name": "example" }'

• production

Create a Service Category

Authorizations

• apiKey

Parameters

Path Parameters

businessId

required

string format: uuid

Business ID

Request Body

Media typeapplication/json

object

name

required

string

Example ^generated

{
  "name": "example"
}

Responses

201

The created Service Category

Media typeapplication/json

object

data

ServiceCategory

object

id

Unique identifier across the platform.

string format: uuid

createdAt

Time when the resource was created (ISO 8601 format).

string format: date-time

updatedAt

Time when the resource was created (ISO 8601 format).

string format: date-time

name

required

string

bookingURL

The URL for patients to book this service category.

string

Example ^generated

{
  "data": {
    "name": "example",
    "bookingURL": "example"
  }
}

400

The name is missing.

Media typeapplication/json

object

error

object

code

number

type

The specific error that occurred.

string

Allowed values: BadRequestError

title

Human-readable description of the error.

string

Example

{
  "error": {
    "code": 400,
    "type": "BadRequestError",
    "title": "Missing required field name"
  }
}

403

The API key is missing or invalid, or the Business cannot be accessed with it.

Media typeapplication/json

object

error

object

code

number

type

The specific error that occurred.

string

Allowed values: UnauthorizedError BusinessArchivedError BusinessDisabledError

title

Human-readable description of the error.

string

Example

{
  "error": {
    "code": 403,
    "type": "UnauthorizedError",
    "title": "Invalid API token"
  }
}

404

The Business does not exist.

Media typeapplication/json

object

error

object

code

number

type

The specific error that occurred.

string

Allowed values: NotFoundError BusinessNotFoundError

title

Human-readable description of the error.

string

Example

{
  "error": {
    "code": 404,
    "type": "BusinessNotFoundError",
    "title": "Business not found"
  }
}