{
  "opencollection": "1.0.0",
  "info": {
    "name": "Webex Admin Address Book Partner Tags API",
    "version": "1.0.0"
  },
  "items": [
    {
      "info": {
        "name": "Partner Tags",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Retrieve all customer tags",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/partner/tags",
            "params": [
              {
                "name": "type",
                "value": "ORGANIZATION",
                "type": "query",
                "description": "List tags associated with an organization."
              }
            ]
          },
          "docs": "Retrieves all tags which are being used by any customer organizations. Once a tag is unassigned from the last customer, it is automatically removed and is not returned by this API.\nThis API can be used by a partner full admin, a read-only partner, or an partner admin. \nThe `type` can have the value ORGANIZATION or SUBSCRIPTION. If not provided, the value is ORGANIZATION"
        },
        {
          "info": {
            "name": "Create or Replace existing customer tags with the provided ones",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/partner/tags/organizations/:orgId/assignTags",
            "params": [
              {
                "name": "orgId",
                "value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS9jOTYwOTZiYi1kYTRhLTQ3NzEtYTc2Zi1kNDEzODQwZWVm1TQ",
                "type": "path",
                "description": "The unique identifier for the customer organization."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Assign or replace tag(s) which for a customer organization. If the tag doesn't already exist, a new one is created and assigned to the customer automatically.\nThis API can be used by partner full admins and partner admins. \nEach tag has a character limit of 25. Currently, there is a limit of 5 tags per organization when creating tags. To remove all the tags, pass an empty array.\nSpecify the customer organization ID in the `orgId` parameter in the URI."
        },
        {
          "info": {
            "name": "Get customer organization's tags",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/partner/tags/organizations/:orgId",
            "params": [
              {
                "name": "orgId",
                "value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS9jOTYwOTZiYi1kYTRhLTQ3NzEtYTc2Zi1kNDEzODQwZWVm1TQ",
                "type": "path",
                "description": "Fetch all customers and associated tags for the customer."
              }
            ]
          },
          "docs": "Retrieve tags associated with a customer organization based on the `orgId` provided.\nThis API can be used by a partner full admin, a read-only partner, or an partner admin. \nSpecify the customer orgId in the `orgId` parameter in the URI."
        },
        {
          "info": {
            "name": "Fetch all customers for a given set of tags",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/partner/tags/organizations",
            "params": [
              {
                "name": "tags",
                "value": "Tag1,Tag2",
                "type": "query",
                "description": "A comma separated list of tags to filter by."
              },
              {
                "name": "max",
                "value": "100",
                "type": "query",
                "description": "Value must be between 1 and 100, inclusive."
              }
            ]
          },
          "docs": "For a set of tags, retrieve all customer organizations that match any one of the tags.\nThis API can be used by a partner full admin, a read-only partner, or an partner admin."
        },
        {
          "info": {
            "name": "Create or Replace existing subscription tags with the provided ones",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/partner/tags/organizations/:orgId/subscriptions/:subscriptionId/assignTags",
            "params": [
              {
                "name": "orgId",
                "value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS9jOTYwOTZiYi1kYTRhLTQ3NzEtYTc2Zi1kNDEzODQwZWVm1TQ",
                "type": "path",
                "description": "The unique identifier for the customer organization."
              },
              {
                "name": "subscriptionId",
                "value": "subscriptionId",
                "type": "path",
                "description": "The unique identifier for the subscription."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Assign or replace tags specific to each subscription for an organization. Each organization may have one or more subscriptions.\nThis API can be used by partner full admins and partner admins. \nCurrently there is a limit of 5 tags per subscription when creating tags. To remove all the tags, pass an empty array.\nSpecify the customer organization ID in the `orgId` parameter in the URI and subscription ID in `subscriptionId` parameter"
        },
        {
          "info": {
            "name": "Subscription List on a given tag name or a set of tags",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/partner/tags/subscriptions",
            "params": [
              {
                "name": "tags",
                "value": "Tag1,Tag2",
                "type": "query",
                "description": "A comma separated list of tags to filter by."
              },
              {
                "name": "max",
                "value": "100",
                "type": "query",
                "description": "Value must be between 1 and 100, inclusive."
              }
            ]
          },
          "docs": "For a partner organization fetch all it's subscriptions with their tag list for a given tag names.\nThis API can be used by partner full admins, partner admins and admin read-only partners."
        },
        {
          "info": {
            "name": "Fetch a Subscription",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/partner/tags/organizations/:orgId/subscriptions/:subscriptionId",
            "params": [
              {
                "name": "orgId",
                "value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS9jOTYwOTZiYi1kYTRhLTQ3NzEtYTc2Zi1kNDEzODQwZWVm1TQ",
                "type": "path",
                "description": "The unique identifier for the customer organization."
              },
              {
                "name": "subscriptionId",
                "value": "subscriptionId",
                "type": "path",
                "description": "The unique identifier for the subscription."
              }
            ]
          },
          "docs": "For a given partner org, customer org and external subscription id, fetch subscription details with its associated tags.\nThis API can be used by partner full admins, partner admins and admin read-only partners."
        }
      ]
    }
  ],
  "bundled": true
}