Create CoworkerMsOfficeCalendar

POST

api

spaces

coworkermsofficecalendars

curl --request POST \
  --url https://spaces.nexudus.com/api/spaces/coworkermsofficecalendars \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "ResourceId": 123,
  "Name": "<string>",
  "SubscriptionId": "<string>",
  "CalendarId": "<string>",
  "SubscriptionExpireDate": "<string>"
}
'

import requests

url = "https://spaces.nexudus.com/api/spaces/coworkermsofficecalendars"

payload = {
    "ResourceId": 123,
    "Name": "<string>",
    "SubscriptionId": "<string>",
    "CalendarId": "<string>",
    "SubscriptionExpireDate": "<string>"
}
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    ResourceId: 123,
    Name: '<string>',
    SubscriptionId: '<string>',
    CalendarId: '<string>',
    SubscriptionExpireDate: '<string>'
  })
};

fetch('https://spaces.nexudus.com/api/spaces/coworkermsofficecalendars', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "Status": 123,
  "Message": "<string>",
  "Value": "<any>",
  "WasSuccessful": true,
  "Errors": [
    {
      "AttemptedValue": "<any>",
      "Message": "<string>",
      "PropertyName": "<string>"
    }
  ]
}

A CoworkerMsOfficeCalendar record represents a Microsoft Office 365 Calendar account connected to a customer’s Nexudus account. These records are created automatically when a customer connects their Office 365 Calendar from the Members Portal or the Nexudus app. Once connected, customers can book resources at a location directly from their Office 365 Calendar. Each record stores the Microsoft Graph push-notification subscription details (SubscriptionId, SubscriptionExpireDate) used to keep the calendar in sync. For more information, see the Office 365 Calendar (Customer) help article.

Authentication

This endpoint requires OAuth2 authentication. Include a valid bearer token in the Authorization header. The authenticated user must be a full unrestricted administrator or have the CoworkerMsOfficeCalendar-Create role.

Request Body

Required Fields

integer

required

ID of the Nexudus resource (room or desk) used as the Microsoft Graph push-notification watch target for this connection.

string

required

Display name of the connected Office 365 Calendar.

string

required

Microsoft Graph push-notification subscription ID used to receive calendar change notifications.

string

required

Microsoft Graph calendar ID of the customer’s connected Office 365 calendar.

string

required

Date and time when the Microsoft Graph push-notification subscription expires and must be renewed.

Optional Fields

integer

ID of the customer who connected their Office 365 Calendar.

Code Examples

curl -X POST \
  "https://spaces.nexudus.com/api/spaces/coworkermsofficecalendars" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "ResourceId": 0,
    "Name": "",
    "SubscriptionId": "",
    "CalendarId": "",
    "SubscriptionExpireDate": "2025-01-15T10:30:00Z"
}'

const response = await fetch(
  'https://spaces.nexudus.com/api/spaces/coworkermsofficecalendars',
  {
    method: 'POST',
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN',
      'Content-Type': 'application/json'
    },
    body: JSON.stringify({
      ResourceId: 0,
      Name: '',
      SubscriptionId: '',
      CalendarId: '',
      SubscriptionExpireDate: '2025-01-15T10:30:00Z'
    })
  }
);

const data = await response.json();

import requests

response = requests.post(
    'https://spaces.nexudus.com/api/spaces/coworkermsofficecalendars',
    headers={
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json'
    },
    json={
        'ResourceId': 0,
        'Name': '',
        'SubscriptionId': '',
        'CalendarId': '',
        'SubscriptionExpireDate': '2025-01-15T10:30:00Z'
    }
)

data = response.json()

Response

200

integer

HTTP status code. 200 on success.

string

A human-readable message confirming the creation.

object

Contains the Id of the newly created record.

boolean

true if the coworkermsofficecalendar was created successfully.

array

null on success.

Example Response

{
  "Status": 200,
  "Message": "CoworkerMsOfficeCalendar was successfully created.",
  "Value": {
    "Id": 87654321
  },
  "OpenInDialog": false,
  "OpenInWindow": false,
  "RedirectURL": null,
  "JavaScript": null,
  "UpdatedOn": "2025-01-15T10:30:00Z",
  "UpdatedBy": "admin@example.com",
  "Errors": null,
  "WasSuccessful": true
}

400

string

A summary of the validation error(s), in the format PropertyName: error message.

any

null on validation failure.

object[]

Array of validation errors.

Show child attributes

any

The value that was submitted for the field, or null if missing.

string

The validation error message.

string

The name of the property that failed validation.

boolean

false when the request fails validation.

Example Response

{
  "Message": "Name: is a required field",
  "Value": null,
  "Errors": [
    {
      "AttemptedValue": null,
      "Message": "is a required field",
      "PropertyName": "Name"
    }
  ],
  "WasSuccessful": false
}

Update CoworkerMsOfficeCalendarUpdate an existing CoworkerMsOfficeCalendar record.

Create CoworkerMsOfficeCalendar

curl --request POST \
  --url https://spaces.nexudus.com/api/spaces/coworkermsofficecalendars \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "ResourceId": 123,
  "Name": "<string>",
  "SubscriptionId": "<string>",
  "CalendarId": "<string>",
  "SubscriptionExpireDate": "<string>"
}
'

import requests

url = "https://spaces.nexudus.com/api/spaces/coworkermsofficecalendars"

payload = {
    "ResourceId": 123,
    "Name": "<string>",
    "SubscriptionId": "<string>",
    "CalendarId": "<string>",
    "SubscriptionExpireDate": "<string>"
}
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    ResourceId: 123,
    Name: '<string>',
    SubscriptionId: '<string>',
    CalendarId: '<string>',
    SubscriptionExpireDate: '<string>'
  })
};

fetch('https://spaces.nexudus.com/api/spaces/coworkermsofficecalendars', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "Status": 123,
  "Message": "<string>",
  "Value": "<any>",
  "WasSuccessful": true,
  "Errors": [
    {
      "AttemptedValue": "<any>",
      "Message": "<string>",
      "PropertyName": "<string>"
    }
  ]
}

Overview

Apps & Marketplace

Billing

Collaboration

Community

Content

CRM

Security

Spaces

Support

System

Create CoworkerMsOfficeCalendar

Authentication

Request Body

Required Fields

Optional Fields

Code Examples

Response

200

400

​Authentication

​Request Body

​Required Fields

​Optional Fields

​Code Examples

​Response

​200

​400

Authentication

Request Body

Required Fields

Optional Fields

Code Examples

Response

200

400