{
  "openapi" : "3.1.0",
  "info" : {
    "title" : "Channels",
    "version" : "1.0.0",
    "description" : "Provides various services for managing channels."
  },
  "paths" : {
    "/api/channel-member" : {
      "get" : {
        "operationId" : "get-api-channel-member",
        "summary" : "Edit Channel Participation",
        "description" : "<div class=\"mb-2\">\n    Edits the participation of a given account in a company channel.\n</div>\n<div>\n    If only the <code>enabled</code> flag is given, the availabilities are not changed. Otherwise, if only\n    <code>oddWeeks</code> or <code>evenWeeks</code> are provided, but none of the weekdays, the account is\n    assumed to be present on every weekday. If only single weekday parameters are passed, the account is\n    considered to be absent on the days not specified.\n</div>\n",
        "parameters" : [ {
          "name" : "accountEmail",
          "in" : "query",
          "required" : true,
          "description" : "E-mail address of the user. Their account must belong to your company, and it must not be locked.",
          "schema" : {
            "type" : "string"
          },
          "example" : "jane@ghost.it"
        }, {
          "name" : "channel",
          "in" : "query",
          "required" : true,
          "description" : "Identifier of a channel belonging to your company.",
          "schema" : {
            "type" : "string"
          },
          "example" : "968AIDVRHOMHBO19G7AIT7AHH0"
        }, {
          "name" : "companyId",
          "in" : "query",
          "required" : true,
          "description" : "Identifier of your company as shown on the <a href=\"/company/profile\">profile page</a>.",
          "schema" : {
            "type" : "string"
          },
          "example" : "JSOM3ACS72QAJ2I1IM1D5VNFGR"
        }, {
          "name" : "key",
          "in" : "query",
          "required" : true,
          "description" : "<a href=\"/kba/M9QWH\">Access key</a> computed from your company's <a href=\"/company/api-integration\">API access parameters</a>. The value can also be provided in the <code>Authorization</code> HTTP header. See kba:M9QWH for details.",
          "schema" : {
            "type" : "string"
          },
          "example" : "6386086c1280c0f76b2c6cfbd3acd4dc21354f21495bd0091706aa3a738e1177"
        }, {
          "name" : "enabled",
          "in" : "query",
          "required" : false,
          "description" : "Flag enabling or disabling the user's participation. Defaults to <code>true</code> if not specified.",
          "schema" : {
            "type" : "string"
          },
          "example" : "true"
        }, {
          "name" : "evenWeeks",
          "in" : "query",
          "required" : false,
          "description" : "Enables the user's participation in even weeks.",
          "schema" : {
            "type" : "string"
          },
          "example" : "true"
        }, {
          "name" : "friday",
          "in" : "query",
          "required" : false,
          "description" : "Enables the user's participation on fridays.",
          "schema" : {
            "type" : "string"
          },
          "example" : "true"
        }, {
          "name" : "monday",
          "in" : "query",
          "required" : false,
          "description" : "Enables the user's participation on mondays.",
          "schema" : {
            "type" : "string"
          },
          "example" : "true"
        }, {
          "name" : "oddWeeks",
          "in" : "query",
          "required" : false,
          "description" : "Enables the user's participation in odd weeks.",
          "schema" : {
            "type" : "string"
          },
          "example" : "true"
        }, {
          "name" : "saturday",
          "in" : "query",
          "required" : false,
          "description" : "Enables the user's participation on saturdays.",
          "schema" : {
            "type" : "string"
          },
          "example" : "true"
        }, {
          "name" : "sunday",
          "in" : "query",
          "required" : false,
          "description" : "Enables the user's participation on sundays.",
          "schema" : {
            "type" : "string"
          },
          "example" : "true"
        }, {
          "name" : "thursday",
          "in" : "query",
          "required" : false,
          "description" : "Enables the user's participation on thursdays.",
          "schema" : {
            "type" : "string"
          },
          "example" : "true"
        }, {
          "name" : "tuesday",
          "in" : "query",
          "required" : false,
          "description" : "Enables the user's participation on tuesdays.",
          "schema" : {
            "type" : "string"
          },
          "example" : "true"
        }, {
          "name" : "wednesday",
          "in" : "query",
          "required" : false,
          "description" : "Enables the user's participation on wednesdays.",
          "schema" : {
            "type" : "string"
          },
          "example" : "true"
        } ],
        "responses" : {
          "200" : {
            "description" : "Successful response.",
            "content" : {
              "application/json" : {
                "examples" : {
                  "example1" : {
                    "value" : {
                      "success" : true,
                      "error" : false,
                      "message" : "The changes have been saved"
                    }
                  }
                }
              }
            }
          },
          "400" : {
            "description" : "Missing parameter or malformed request",
            "content" : {
              "application/json" : {
                "examples" : {
                  "example1" : {
                    "value" : {
                      "success" : false,
                      "error" : true,
                      "message" : "The parameter {missingParameter} must be filled."
                    }
                  }
                }
              }
            }
          },
          "401" : {
            "description" : "Authentication required but none provided",
            "content" : {
              "application/json" : { }
            }
          },
          "403" : {
            "description" : "Invalid authentication or missing permission",
            "content" : {
              "application/json" : { }
            }
          },
          "404" : {
            "description" : "Resource not found",
            "content" : {
              "application/json" : { }
            }
          },
          "405" : {
            "description" : "Incorrect request method, e.g. GET instead of POST",
            "content" : {
              "application/json" : { }
            }
          },
          "500" : {
            "description" : "Unexpected server-side error",
            "content" : {
              "application/json" : { }
            }
          }
        }
      }
    }
  }
}