Schedule sharing
  • 22 Nov 2022
  • 1 Minute to read
  • Contributors
  • Dark
    Light
  • PDF

Schedule sharing

  • Dark
    Light
  • PDF

Article summary

Collection

PUT external/schedule/{externalId}/sharing

NameData TypeDescription
Content-type:application/jsonfor all requests
Authorization:EAPI {token}for all requests

Body Parameters

Parameters indicated with a * are mandatory

Name
Data Type
Description
*FilterObjectExternal Id. Should be unique. Alpha-Numeric. Autogenerated by default.
*Filter.UsersArray Of StringFilter users by User Names. Only exists users will be added.
AccessBooleanUsers should have access to the schedule.
True - Grant access
False - Revoke access

Sample Request URL

https://api.cirrusplatform.com/api/v1/integrations/external/schedule/scheExt1/sharing 

Sample Request

{ Filter:
 { "Users": ["alexey", "authorone"]},
  "Access": true
 }



Response codes

CodeDescription
200Successful operation
403Not allowed to use external API
400Possible error codes:
100: Request body can not be null or empty.
216: Filter.Users can not be null or empty
300: SScheduleExternalId can not be null or empty
301: Schedule has not been found
500Internal server error


Was this article helpful?