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

POSThttps://connect.getseam.com/user_identities/enrollment_automations/delete

Authorization

pat_with_workspaceconsole_sessionapi_key

Body

application/json

enrollment_automation_id*string (uuid)

Response

200400401

OK

Body

application/json

ok*boolean

Request

JavaScriptCurl

const response = await fetch('https://connect.getseam.com/user_identities/enrollment_automations/delete', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer API Token",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "enrollment_automation_id": "123e4567-e89b-12d3-a456-426614174000"
    }),
});
const data = await response.json();

Response

{
  "ok": false
}

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
}