Overview

Bulk Operations APIs run one action against many items, such as SIM cards. You can activate, suspend, terminate, and update items in bulk.

Use these APIs to manage large device or SIM fleets. Bulk operations use a CSV file to change many SIMs.

Common job types update status, packages, portfolios, and customerSuspend. You can also update attributes such as friendlyName and orderId. When the job completes, download its response file for each SIM result.

When to use bulk operations

Use bulk operations to perform the same action on many items. For example:

Activate multiple SIM cards.
Suspend or terminate a batch of SIM cards.
Update attributes or configurations for a group of items.
Upload and process large datasets in one operation.

Before you start, obtain these values:

Item

Description

base64

Base64 encoding of clientId:clientSecret for a service account with file and job permissions.

fileUrl

Base URL of the File service.

jobUrl

Base URL of the Job service.

env

Your environment: stage or prod.

portfolioId

The portfolio that owns the files and jobs.

If you need these values, email Sales Admin with the subject Request Prerequisites for bulk operations.

Include these details in the email:

Company name
Your role
Contact phone number
Contact email address

Workflow

Run the bulk workflow in this order:

Get Token: Mint an OAuth2 access token.
Create File: Create a file record and S3 path.
Upload or Download File: Use action=upload to retrieve presigned S3 upload credentials.
Upload File to S3: Select and send your local CSV file.
Job Create: Start the bulk job for the uploaded CSV.
Job Update: Set the status to queued to trigger orchestration.
Get ResponseFile: Poll until responseFileId is not null.
Upload or Download File: Use action=download to request a presigned results URL.
Download via Pre-signed URL: Retrieve the results file and save it locally.