Delete Enrollment

Deletes an enrollment request. Only enrollments in DRAFT status can be deleted. This operation is idempotent.

DELETE /enrollments/{enrollmentId}

This is a beta endpoint. We may make backwards incompatible changes.

This endpoint allows you to delete a transaction enrollment that is still in DRAFT status. To update or delete an enrollment that is already in STEDI_ACTION_REQUIRED, PROVIDER_ACTION_REQUIRED, PROVISIONING, LIVE, REJECTED, or CANCELED status, contact support.

Authorizations

Authorization · string · required · header

A Stedi API Key for authentication.

Path Parameters

enrollmentId · string

The Stedi-assigned identifier for the enrollment you want to delete.

Response

DeleteEnrollment 200 response

cURL

curl --request DELETE \
  --url "https://enrollments.us.stedi.com/2024-09-01/enrollments/{enrollmentId}" \
  --header "Authorization: <api_key>"

JavaScript

fetch("https://enrollments.us.stedi.com/2024-09-01/enrollments/{enrollmentId}", {
  headers: {
    "Authorization": "<api_key>"
  }
})

Go

package main

import (
  "fmt"
  "net/http"
  "io/ioutil"
)

func main() {
  url := "https://enrollments.us.stedi.com/2024-09-01/enrollments/{enrollmentId}"

  req, _ := http.NewRequest("DELETE", url, nil)
  req.Header.Add("Authorization", "<api_key>")
  res, _ := http.DefaultClient.Do(req)
  defer res.Body.Close()
  body, _ := ioutil.ReadAll(res.Body)

  fmt.Println(res)
  fmt.Println(string(body))
}

Python

import requests

url = "https://enrollments.us.stedi.com/2024-09-01/enrollments/{enrollmentId}"

response = requests.request("DELETE", url, headers = {
  "Authorization": "<api_key>"
})

print(response.text)

Java

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.net.http.HttpResponse.BodyHandlers;
import java.time.Duration;

HttpClient client = HttpClient.newBuilder()
  .connectTimeout(Duration.ofSeconds(10))
  .build();

HttpRequest.Builder requestBuilder = HttpRequest.newBuilder()
  .uri(URI.create("https://enrollments.us.stedi.com/2024-09-01/enrollments/{enrollmentId}"))
  .header("Authorization", "<api_key>")
  .DELETE()
  .build();

try {
  HttpResponse<String> response = client.send(requestBuilder.build(), BodyHandlers.ofString());
  System.out.println("Status code: " + response.statusCode());
  System.out.println("Response body: " + response.body());
} catch (Exception e) {
  e.printStackTrace();
}

200

Empty

400

{
  "message": "string",
  "fieldList": [
    {
      "path": "string",
      "message": "string"
    }
  ]
}

401

{
  "message": "string",
  "code": "string"
}

403

{
  "message": "string",
  "code": "string"
}

404

{
  "message": "string",
  "code": "string"
}

500

{
  "message": "string",
  "code": "string"
}