API : Employee Subscriptions Update

API : Employee Subscriptions Update

Introduction

This request will update an employee subscription.

When updating, you do not need to send the full object. As little as a single property can be sent, so only send the properties you need to update, and the rest will be untouched.

Request

URL	https://api.telecomx.dk/employeeSubscription/SUBSCRIPTION_ID
Method	POST
Access level	RESELLER if the subscription belongs to the reseller or a sub reseller. RESELLER_ADMIN or ADMIN (required for common subscriptions).
Param	SUBSCRIPTION_ID	Id of the employee subscription.
Body	title	String	`[optional]` Name of the subscription, 1-255 characters.
	description	String	`[optional]` A longer description of what the subscription offers.
	email	Boolean	`[optional]` True if subscribers will be notified by e-mail.
	sms	Boolean	`[optional]` True if subscribers will be notified by SMS.

Reseller cannot be changed on an existing subscription.

Request body example

{
  "description": "When ever we need to perform upgrades that may affect your services, we send out an announcement 14 days in advance. Subscribe to this to get notified."
}

Response

The response will be the updated employee subscription, if no errors occurred.

JSON object
_id	Id	Unique employee subscription id.
reseller	Id	Id of the reseller the subscription belongs to. Null for common subscriptions.
title	String	Name of the subscription.
description	String	A longer description of what the subscription offers.
email	Boolean	True if subscribers will be notified by e-mail.
sms	Boolean	True if subscribers will be notified by SMS.

Note that properties holding no value may be omitted from the object.

Example

{
  "_id": "650000000000000000000001",
  "reseller": null,
  "title": "Planned service windows",
  "description": "When ever we need to perform upgrades that may affect your services, we send out an announcement 14 days in advance. Subscribe to this to get notified.",
  "email": true,
  "sms": false
}

Errors

Error code	Message	Description
422	id	Subscription id is not valid
404	employeeSubscription	Employee subscription not found
422	title	Title is not valid
422	email	No transmission type set, at least email or sms must be selected
403	access_denied	Insufficient access level
500	internal_error	<Unspecified>

Table of Contents