{
  "opencollection": "1.0.0",
  "info": {
    "name": "Attentive Access Token Segments API",
    "version": "1.0"
  },
  "request": {
    "auth": {
      "type": "bearer",
      "token": "{{bearerToken}}"
    }
  },
  "items": [
    {
      "info": {
        "name": "Segments",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Add Bulk Segment Members",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.attentivemobile.com/v1/v2/bulk/segments/members",
            "headers": [
              {
                "name": "Authorization",
                "value": ""
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Add members to a segment in bulk. This endpoint accepts 1 to 10,000 members per request. Members are identified by email, phone number, and/or client user ID. The request is validated, queued for asynchronous processing, and a unique batch job ID is returned for tracking the status.\n\n**Request Limits:**\n- Minimum: 1 member per request\n- Maximum: 10,000 members per request\n- At least one identifier (email, phone, or clientUserId) required per member\n\n**Processing:**\n- Jobs are processed asynchron"
        },
        {
          "info": {
            "name": "Remove Bulk Segment Members",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.attentivemobile.com/v1/v2/bulk/segments/members",
            "headers": [
              {
                "name": "Authorization",
                "value": ""
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Remove members from a segment in bulk. This endpoint accepts 1 to 10,000 members per request. Members are identified by email, phone number, and/or client user ID. The request is validated, queued for asynchronous processing, and a unique batch job ID is returned for tracking the status.\n\n**Request Limits:**\n- Minimum: 1 member per request\n- Maximum: 10,000 members per request\n- At least one identifier (email, phone, or clientUserId) required per member\n\n**Processing:**\n- Jobs are processed asyn"
        },
        {
          "info": {
            "name": "List segments",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.attentivemobile.com/v1/v2/segments",
            "params": [
              {
                "name": "name",
                "value": "",
                "type": "query",
                "description": "Filter by segment name (partial match). Cannot be empty or whitespace only."
              },
              {
                "name": "externalId",
                "value": "",
                "type": "query",
                "description": "Filter by external ID. Cannot be empty or whitespace only."
              },
              {
                "name": "updatedSince",
                "value": "",
                "type": "query",
                "description": "Filter by segments updated since this timestamp (ISO 8601 format)"
              },
              {
                "name": "cursor",
                "value": "",
                "type": "query",
                "description": "Pagination cursor from previous response. Cannot be empty or whitespace only."
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "Maximum number of results to return (default 20, max 1000)"
              }
            ],
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Lists segments with optional filtering by name, external ID, or update timestamp.\n\nScopes Required: [segments:Read OR segments:Write]\n\nDefault Rate Limit: 100 requests per second\n"
        },
        {
          "info": {
            "name": "Create new segment",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.attentivemobile.com/v1/v2/segments",
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Creates a new empty segment with the specified name and optional description.\n\nScopes Required: [segments:Write]\n\nDefault Rate Limit: 100 requests per second\n"
        },
        {
          "info": {
            "name": "Get segment by external ID",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.attentivemobile.com/v1/v2/segments/external/:externalId",
            "params": [
              {
                "name": "externalId",
                "value": "",
                "type": "path",
                "description": "External ID of the segment"
              }
            ],
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Retrieves segment details by external ID.\n\nScopes Required: [segments:Read OR segments:Write]\n\nDefault Rate Limit: 100 requests per second\n"
        },
        {
          "info": {
            "name": "Partial update segment by external ID",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://api.attentivemobile.com/v1/v2/segments/external/:externalId",
            "params": [
              {
                "name": "externalId",
                "value": "",
                "type": "path",
                "description": "External ID of the segment"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Partially updates an existing segment. Only provided fields will be updated.\n\nScopes Required: [segments:Write]\n\nDefault Rate Limit: 100 requests per second\n"
        },
        {
          "info": {
            "name": "Archive segment by external ID",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.attentivemobile.com/v1/v2/segments/external/:externalId",
            "params": [
              {
                "name": "externalId",
                "value": "",
                "type": "path",
                "description": "External ID of the segment to archive"
              }
            ],
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Archives (soft deletes) a segment by external ID. The segment will no longer be visible in list operations but can be restored if needed.\n\nScopes Required: [segments:Write]\n\nDefault Rate Limit: 100 requests per second\n"
        }
      ]
    }
  ],
  "bundled": true
}