Create a Link Group

post

/api/link/LinkGroups/

Creates a link group.
The minimum required properties in the request body are:
  • LinkGroupName
  • ParentLinkGroupID
  • Links

Request

There are no request parameters for this operation.

Supported Media Types
Request Body - application/json ()
Root Schema : schema
Type: object
Show Source
  • The link group name.
    To avoid confusion with numeric IDs, the name value cannot be integers only or integers prefixed with the + or - symbols only. It must contain letters or other characters. For example, 1234, +1234, and -1234 are not valid, but US1234, US+1234 and US_1234 are.
    Example: Root
  • Links
    Displays all of the links that are in the group.
  • Parent Group ID for the new Link Group
    Example: 1
  • Remove Link from other Link Groups. If checked, any links added to the group will be removed from other groups. Allowed Values: - 0 => FALSE - 1 => TRUE
    Example: 0
Nested Schema : Links
Type: array
Displays all of the links that are in the group.
Show Source
Example:
[
    1004
]
Back to Top

Response

Supported Media Types

200 Response

Successful operation
Body ()
Root Schema : schema
Match All
Show Source
Nested Schema : SuccessfulAddOperation
Type: object
The response body for a successful add operation.
Show Source
Nested Schema : type
Type: object
Show Source
Nested Schema : data
Type: object
The properties of the new link group.
Show Source

Default Response

Failed operation
Body ()
Root Schema : schema
Type: object
Show Source
Nested Schema : errors
Type: array
The list of errors reported. Validation errors will be keyed by record field.
Show Source
Nested Schema : items
Type: object
An error.
Back to Top