Sign in

v3

latestOpenAPI 3.0.12026-07-31240345599.7 KB
Forwarding rules

Create forwarding rule

Creates a forwarding rule with the given properties.

post/api/{cloudId}/v1/forwarding-rules

Request body

toUserIdstring required

The id of user who will receive the forwarded notifications.

fromUserIdstring required

The id of user whose notifications will be forwarded.

startDatestring date-time required

The date and time for forwarding will start, which takes a date format as (yyyy-MM-dd'T'HH:mm:ssZ) (e.g. 2017-01-15T08:00:00+02:00).

endDatestring date-time required

The date and time for forwarding will end, which takes a date format as (yyyy-MM-dd'T'HH:mm:ssZ) (e.g. 2017-01-15T08:00:00+02:00).

Example request

{
  "toUserId": "e58d6ee3-37bd-432f-9ded-64808b761ae0",
  "fromUserId": "4b26961a-a837-49d2-a1fe-0973013e3c3b",
  "startDate": "2022-07-05T08:00:00Z",
  "endDate": "2022-07-06T18:00:00Z"
}

Response

Returned if the request is successful.

idstring

Identifier of the forwarding rule.

fromUserIdstring

The id of user whose notifications will be forwarded.

toUserIdstring

The id of user who will receive the forwarded notifications.

startDatestring

The date and time for forwarding will start, which takes a date format as (yyyy-MM-dd'T'HH:mm:ssZ) (e.g. 2017-01-15T08:00:00+02:00).

endDatestring

The date and time for forwarding will end, which takes a date format as (yyyy-MM-dd'T'HH:mm:ssZ) (e.g. 2017-01-15T08:00:00+02:00).

Example response

{
  "id": "6667cb5b-a5ce-4550-9469-1dbcabac6ffb",
  "fromUserId": "e58d6ee3-37bd-432f-9ded-64808b761ae0",
  "toUserId": "4b26961a-a837-49d2-a1fe-0973013e3c3b",
  "startDate": "2022-07-05T08:00:00Z",
  "endDate": "2022-07-06T18:00:00Z"
}