See Bulk Provisioning for the full guide.

​
Endpoints

MethodPathDescription
POST/api/v1/partner/provisioning/bulkSubmit a batch
GET/api/v1/partner/provisioning/bulk/{batch_id}Poll batch status
Both endpoints require X-API-Key.

​
Submit batch body

{
  "subscribers": [
    {
      "plan_version_id": "uuid",
      "location_hash": "10-char hex",
      "email": "string",
      "firstname": "string",
      "lastname": "string",
      "street": "string",
      "housenumber": "string",
      "postalcode": "string",
      "city": "string",
      "province": "string"
    }
  ]
}
Max 100 entries per batch. Returns 202 Accepted with a batch_id.

​
Poll response

{
  "batch_id": "uuid",
  "status": "in_progress | completed | completed_with_errors",
  "total": 100,
  "completed": 87,
  "failed": 3,
  "results": [
    {
      "email": "alice@example.com",
      "status": "completed | pending | failed",
      "subscription_id": "uuid",
      "subscriber_id": "uuid",
      "job_id": "uuid",
      "error": "string (on failure only)"
    }
  ]
}