PUT/spaces/api/v1/requiredreading/spaces/{spaceID}/pages/{pageID}/audience.json

Sets the required audience of a given page

ko

Path Params

  • Name
    spaceID
    Type
    integer
    required
    Description
  • Name
    pageID
    Type
    integer
    required
    Description

Body Params

    • Name
      requiredReading
      Type
      object
      Description
      AudienceRequest represents a request to assign an audience for a page

    Responses

    • Code
      200
      Type
      object
      Schema
      Description
      200 OK
    • Code
      400
      Type
      object
      Schema
      Description
      400 Bad Request
    • Code
      404
      Type
      object
      Schema
      Description
      404 Not Found
    • Code
      500
      Type
      object
      Schema
      Description
      500 Internal Server Error

    Examples

    200 OK

    AudienceResp
    {
      "requiredReading": {
        "audience": {
          "all": true,
          "companies": [
            {
              "company": {
                "id": 0,
                "meta": {},
                "type": "string"
              },
              "users": [
                {
                  "id": 0,
                  "meta": {},
                  "type": "string"
                }
              ]
            }
          ]
        }
      }
    }