Delete an Enrollment Automation

Delete a specified enrollment automation

Deletes a specified enrollment automation. You must delete all enrollment automations associated with a user identity before deleting the user identity.

/user_identities/enrollment_automations/delete

post

Deletes a specified enrollment automation. You must delete all enrollment automations associated with a user identity before deleting the user identity.

Authorizations

pat_with_workspaceconsole_session_with_workspaceapi_key

Body

enrollment_automation_idstring · uuidRequired

ID of the enrollment automation that you want to delete.

Responses

200

OK

application/json

400

Bad Request

401

Unauthorized

post

HTTPcURLJavaScriptPython

POST /user_identities/enrollment_automations/delete HTTP/1.1
Host: connect.getseam.com
Authorization: Bearer API Token
Content-Type: application/json
Accept: */*
Content-Length: 67

{
  "enrollment_automation_id": "123e4567-e89b-12d3-a456-426614174000"
}

{
  "ok": true
}

Request

Specify the desired enrollment automation by including the corresponding enrollment_automation_id in the request body.

Request Body Parameters

Parameter	Type	Description
enrollment_automation_id	String Required	ID of the desired enrollment automation

Sample Request

cURL (bash)

curl -X 'POST' \
  'https://connect.getseam.com/enrollment_automations/delete' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer ${API_KEY}' \
  -H 'Content-Type: application/json' \
  -d '{
  "enrollment_automation_id": "05505650-aa57-49ab-8f19-429738758895"
}'

Go

_, uErr := client.EnrollmentAutomations.Delete(context.Background(), &api.EnrollmentAutomationsDeleteRequest{
  EnrollmentAutomationId: "05505650-aa57-49ab-8f19-429738758895",
})

if uErr != nil {
  return uErr
}

return nil

Response

Returns a Boolean ok status indicator.

Sample Response

JSON

{
  "ok": true
}