{
  "opencollection": "1.0.0",
  "info": {
    "name": "Coveo Activity Activities Group Invites API",
    "version": "1.0.0"
  },
  "request": {
    "auth": {
      "type": "oauth2",
      "flow": "authorization_code",
      "authorizationUrl": "https://platform.cloud.coveo.com/oauth/authorize",
      "accessTokenUrl": "https://platform.cloud.coveo.com/oauth/token",
      "credentials": {
        "clientId": "{{clientId}}",
        "clientSecret": "{{clientSecret}}"
      }
    }
  },
  "items": [
    {
      "info": {
        "name": "Group Invites",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List Invites",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/groups/:groupId/invites",
            "params": [
              {
                "name": "organizationId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br />**Example:** `mycoveocloudv2organizationg8tp8wu3`"
              },
              {
                "name": "groupId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the target [group](https://docs.coveo.com/en/2867/).</br>**Example:**`myorganization-bfghkjfjb674jh5egjk`"
              }
            ]
          },
          "docs": "Lists all invites of a [group](https://docs.coveo.com/en/2867/).<br /><br /><details><summary>Privilege required</summary>\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"GROUP\",\"type\":\"VIEW\",\"targetId\":\"*\"}\n```\n</details>"
        },
        {
          "info": {
            "name": "Invite User to Group",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/groups/:groupId/invites",
            "params": [
              {
                "name": "organizationId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br />**Example:** `mycoveocloudv2organizationg8tp8wu3`"
              },
              {
                "name": "groupId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the target [group](https://docs.coveo.com/en/2867/).</br>**Example:**`myorganization-bfghkjfjb674jh5egjk`"
              },
              {
                "name": "sendEmail",
                "value": "",
                "type": "query",
                "description": "Whether to send an invitation email alongside the invite."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Invites a user to a [group](https://docs.coveo.com/en/2867/).<br /><br /><details><summary>Privilege required</summary>\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"GROUP\",\"type\":\"EDIT\",\"targetId\":\"{groupId}\"}\n```\n</details>"
        },
        {
          "info": {
            "name": "Decline Invite to Group",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/groups/:groupId/invites/decline",
            "params": [
              {
                "name": "organizationId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br />**Example:** `mycoveocloudv2organizationg8tp8wu3`"
              },
              {
                "name": "groupId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the target [group](https://docs.coveo.com/en/2867/).</br>**Example:**`myorganization-bfghkjfjb674jh5egjk`"
              }
            ]
          },
          "docs": "Declines an invite to a [group](https://docs.coveo.com/en/2867/)."
        },
        {
          "info": {
            "name": "Accept Invite to Group",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/groups/:groupId/invites/accept",
            "params": [
              {
                "name": "organizationId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br />**Example:** `mycoveocloudv2organizationg8tp8wu3`"
              },
              {
                "name": "groupId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the target [group](https://docs.coveo.com/en/2867/).</br>**Example:**`myorganization-bfghkjfjb674jh5egjk`"
              }
            ]
          },
          "docs": "Accepts an invite to a [group](https://docs.coveo.com/en/2867/)."
        },
        {
          "info": {
            "name": "Delete Invite to Group",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/groups/:groupId/invites/:usernameOrEmail",
            "params": [
              {
                "name": "organizationId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br />**Example:** `mycoveocloudv2organizationg8tp8wu3`"
              },
              {
                "name": "groupId",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the target [group](https://docs.coveo.com/en/2867/).</br>**Example:**`myorganization-bfghkjfjb674jh5egjk`"
              },
              {
                "name": "usernameOrEmail",
                "value": "",
                "type": "path",
                "description": "The username or email of the invited user.</br>**Example:** `jsmith@email.com-google`"
              }
            ]
          },
          "docs": "Deletes an invite to a [group](https://docs.coveo.com/en/2867/).<br /><br /><details><summary>Privilege required</summary>\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"GROUP\",\"type\":\"EDIT\",\"targetId\":\"{groupId}\"}\n```\n</details>"
        }
      ]
    }
  ],
  "bundled": true
}