Trigger SIM operation | emnify Documentation

curl -X POST https://cdn.emnify.net/api/v1/sim/operation \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "action": {
    "id": 1
  },
  "target": [
    {
      "sim": {
        "id": 7372275
      },
      "eid": "89123247065724874780755570224813"
    }
  ],
  "discovery_service": {
    "id": 1
  }
}'

{
  "id": "58f8f8f8-aaaa-4bbb-8ccc-111111111111",
  "action": {
    "id": 1,
    "description": "Link by SIM"
  },
  "status": {
    "id": 1,
    "description": "Processing"
  },
  "creation_date": "2025-10-01T09:00:00.000Z",
  "last_updated_at": "2025-10-01T09:00:00.000Z",
  "target": [
    {
      "sim": {
        "id": 7372275
      },
      "eid": "89123247065724874780755570224813"
    }
  ],
  "total_count": 1,
  "failed_count": 0,
  "success_count": 0,
  "discovery_service": {
    "id": 1,
    "description": "Apple"
  }
}

Trigger a SIM operation. Unlinking a SIM whose profile was published to a discovery service also withdraws the profile from that discovery service.

Authentication

AuthorizationBearer

An auth_token should be provided to authenticate a session. To obtain an auth_token, see the POST request to /api/v1/authenticate.

Request

This endpoint expects an object.

actionobjectRequired

targetlist of objectsRequired

productobjectOptional

discovery_serviceobjectOptional

Discovery service to publish the linked profiles to, so devices can download them without an activation code. Use 1 for Apple or 2 for Android, with Link by SIM and Link by Product only. If publication fails, the SIM isn’t linked.

Response headers

LinkstringOptional

Comma-separated list of created SIM operation resource URLs with rel=“item”.

Response

Created, SIM operation scheduled

idstringformat: "uuid"

Operation ID

actionobject

statusobject

creation_datestringformat: "date-time"

last_updated_atstringformat: "date-time"

productobjectOptional

finalization_datestring or nullOptionalformat: "date-time"

targetlist of objectsOptional

total_countintegerOptional

failed_countintegerOptional

success_countintegerOptional

errorlist of objectsOptional

discovery_serviceobjectOptional

Discovery service the request named, as listed by GET /api/v1/sim/operation/discovery_service. It’s the requested value, not a result for each target. Omitted when the request named none.

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error