Sign in
address book

Add a Rule

This function is an API endpoint that adds a new rule to a shared address book. It is tagged with "address book" for OpenAPI documentation.

Parameters

  • request: The request containing the details of the rule to be added.

Returns

If successful, this function returns an ActionResponse::Empty indicating that the rule was successfully added. <br> If the system is in maintenance mode, this function returns a status::Unauthorized error.

Errors

This function will return an error if the system is in maintenance mode.

post/api/ab/rule

Request body

guidstring required
userstring nullable
groupstring nullable
ruleinteger required

Response


# 200 OK
This response is given when the request is successful.
The body is empty if there is no error,
The body contains a json object with the error {"error":"Error message"}

Changes

Changed in 2 of the 11 revisions of this API.11