Update Enrollment

curl -X PATCH "https://api.athena-erp.com/api/enrollments/a1b2c3d4-e5f6-7890-abcd-ef1234567890" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "status": "active"
  }'

{
  "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "school_id": "550e8400-e29b-41d4-a716-446655440000",
  "student_id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
  "school_year_id": "c3d4e5f6-a7b8-9012-cdef-123456789012",
  "grade_level": "10°",
  "group_code": "A",
  "shift": "morning",
  "status": "active",
  "status_history": [
    {
      "status": "pending_documents",
      "changed_at": "2024-01-15T10:30:00Z",
      "changed_by": "d4e5f6a7-b8c9-0123-def1-234567890123"
    },
    {
      "status": "active",
      "changed_at": "2024-01-20T14:25:00Z",
      "changed_by": "d4e5f6a7-b8c9-0123-def1-234567890123"
    }
  ],
  "simat_status": {},
  "extra_data": {
    "special_needs": false,
    "transportation": "school_bus"
  },
  "student_name": "Juan Pérez García",
  "school_year_name": "2024",
  "documents": [],
  "created_at": "2024-01-15T10:30:00Z",
  "updated_at": "2024-01-20T14:25:00Z"
}

PATCH

api

enrollments

{enrollment_id}

curl -X PATCH "https://api.athena-erp.com/api/enrollments/a1b2c3d4-e5f6-7890-abcd-ef1234567890" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "status": "active"
  }'

{
  "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "school_id": "550e8400-e29b-41d4-a716-446655440000",
  "student_id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
  "school_year_id": "c3d4e5f6-a7b8-9012-cdef-123456789012",
  "grade_level": "10°",
  "group_code": "A",
  "shift": "morning",
  "status": "active",
  "status_history": [
    {
      "status": "pending_documents",
      "changed_at": "2024-01-15T10:30:00Z",
      "changed_by": "d4e5f6a7-b8c9-0123-def1-234567890123"
    },
    {
      "status": "active",
      "changed_at": "2024-01-20T14:25:00Z",
      "changed_by": "d4e5f6a7-b8c9-0123-def1-234567890123"
    }
  ],
  "simat_status": {},
  "extra_data": {
    "special_needs": false,
    "transportation": "school_bus"
  },
  "student_name": "Juan Pérez García",
  "school_year_name": "2024",
  "documents": [],
  "created_at": "2024-01-15T10:30:00Z",
  "updated_at": "2024-01-20T14:25:00Z"
}

Path Parameters

enrollment_id

uuid

required

Unique identifier of the enrollment to update

Request Body

All fields are optional. Only include fields you want to update.

grade_level

string

Update the grade level

group_code

string

Update the group or class code

shift

string

Update the school shift

status

string

Update the enrollment status. When changed, this will be automatically tracked in the status_history array.Common status values:

pending_documents - Awaiting document submission
active - Enrollment is active
completed - Enrollment completed
withdrawn - Student withdrawn

status_history

array

Manually update the status history array (advanced use only)

simat_status

object

Update SIMAT (Colombian education system) status data

extra_data

object

Update additional custom data for the enrollment

Response

Returns the updated enrollment object with all fields.

uuid

Unique enrollment identifier

school_id

uuid

School identifier

student_id

uuid

Student identifier

school_year_id

uuid

School year identifier

grade_level

string

Grade level

group_code

string

Group or class code

shift

string

School shift

status

string

Current enrollment status

status_history

array

Array of status changes with timestamp and user who made the change

simat_status

object

SIMAT status data

extra_data

object

Additional custom data

student_name

string

Full name of the student

school_year_name

string

Name of the school year

documents

array

Array of enrollment documents

created_at

datetime

Timestamp when the enrollment was created

updated_at

datetime

Timestamp when the enrollment was last updated

curl -X PATCH "https://api.athena-erp.com/api/enrollments/a1b2c3d4-e5f6-7890-abcd-ef1234567890" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "status": "active"
  }'

{
  "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "school_id": "550e8400-e29b-41d4-a716-446655440000",
  "student_id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
  "school_year_id": "c3d4e5f6-a7b8-9012-cdef-123456789012",
  "grade_level": "10°",
  "group_code": "A",
  "shift": "morning",
  "status": "active",
  "status_history": [
    {
      "status": "pending_documents",
      "changed_at": "2024-01-15T10:30:00Z",
      "changed_by": "d4e5f6a7-b8c9-0123-def1-234567890123"
    },
    {
      "status": "active",
      "changed_at": "2024-01-20T14:25:00Z",
      "changed_by": "d4e5f6a7-b8c9-0123-def1-234567890123"
    }
  ],
  "simat_status": {},
  "extra_data": {
    "special_needs": false,
    "transportation": "school_bus"
  },
  "student_name": "Juan Pérez García",
  "school_year_name": "2024",
  "documents": [],
  "created_at": "2024-01-15T10:30:00Z",
  "updated_at": "2024-01-20T14:25:00Z"
}

Status Workflow

The enrollment status typically follows this workflow:

pending_documents - Initial state when enrollment is created
active - All documents uploaded and enrollment is active
completed - School year completed
withdrawn - Student withdrawn from enrollment

When the status is changed, the system automatically:

Appends the change to the status_history array
Records the timestamp of the change
Records the user ID who made the change

Permissions Required

write:enrollment
write:all

Path Parameters

enrollment_id

string

required

Unique identifier of the enrollment to update

Body

application/json

grade_level

string

Update the grade level

group_code

string

Update the group or class code

shift

string

Update the school shift

status

string

Update the enrollment status. When changed, this will be automatically tracked in the status_history array. Common status values: pending_documents - Awaiting document submission active - Enrollment is active completed - Enrollment completed withdrawn - Student withdrawn

status_history

object[]

Manually update the status history array (advanced use only)

simat_status

object

Update SIMAT (Colombian education system) status data

extra_data

object

Update additional custom data for the enrollment

Response

200 - application/json

Response 200

string

Unique enrollment identifier

school_id

string

School identifier

student_id

string

Student identifier

school_year_id

string

School year identifier

grade_level

string

Grade level

group_code

string

Group or class code

shift

string

School shift

status

string

Current enrollment status

status_history

object[]

Array of status changes with timestamp and user who made the change

simat_status

object

SIMAT status data

extra_data

object

Additional custom data

student_name

string

Full name of the student

school_year_name

string

Name of the school year

documents

object[]

Array of enrollment documents

created_at

object

Timestamp when the enrollment was created

updated_at

object

Timestamp when the enrollment was last updated

Get Enrollment

Enrollment Documents

⌘I

Build docs developers (and LLMs) love

Get started for free Talk to us

Authentication

Enrollments

Students

Academic

Discipline

Communications

Schools

Path Parameters

Request Body

Response

Status Workflow

Permissions Required

Path Parameters

Body

Response

Build docs developers (and LLMs) love

Authentication

Enrollments

Students

Academic

Discipline

Communications

Schools

​Path Parameters

​Request Body

​Response

​Status Workflow

​Permissions Required

Path Parameters

Body

Response

Build docs developers (and LLMs) love

Path Parameters

Request Body

Response

Status Workflow

Permissions Required