Delete a Reminder Template

DELETE

/businesses/{businessId}/notifications/reminder-templates/{reminderTemplateId}

const url = 'https://api.upvio.com/v1/businesses/example/notifications/reminder-templates/example';
const options = {method: 'DELETE', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request DELETE \
  --url https://api.upvio.com/v1/businesses/example/notifications/reminder-templates/example \
  --header 'Authorization: Bearer <token>'

Soft-delete a reminder template.

Authorizations

apiKey

Parameters

Path Parameters

businessId

required

The ID of the Business.

string

reminderTemplateId

required

The ID of the Reminder Template.

string

Responses

204

Confirmation of deletion.

400

The reminder template ID is malformed.

application/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": "Invalid platformId format."
  }
}

403

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

application/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 reminder template does not exist.

application/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": "NotFoundError",
    "title": "Reminder Template not found"
  }
}