MAmattilda-education
Colegiaturas

Actualizar Colegiatura

Actualización de datos de una Colegiatura

put/memberships/{membershipID}

Request

  • Base URL
    https://api.mattilda.school/matti_api/v1
  • URL
    https://api.mattilda.school/matti_api/v1/memberships/{membershipID}
  • Auth
    API key in header api_key

Path parameters

membershipIDstring required

ID de la colegiatura que se desea trabajar.

Headers

campusIDstring uuid required

ID del Campus que se desea trabajar.

periodIDstring uuid required

ID del periodo que se desea trabajar.

Request body

namestring
program_idstring
workdayboolean
periodicitystring
payment_planinteger
amountinteger
pay_datesstring[]
external_idstring
metadataobject

Campo arbitrario de datos de terceros

Example request

{
  "name": "Administración",
  "program_id": "prm_48ec2f25-74e1-406a-a42f-4636bcce7877",
  "periodicity": "monthly",
  "payment_plan": 10,
  "amount": 1000,
  "pay_dates": [
    "2023-11-10"
  ],
  "external_id": "123abc",
  "metadata": {
    "id_alumno": "123abc"
  }
}

Response

Ok

idstring
namestring
program_idstring
workdayboolean
periodicitystring
payment_planinteger
amountinteger
pay_datesstring[]
external_idstring
metadataobject

Campo arbitrario de datos de terceros

Example response

{
  "id": "mbs_520dd7ee-5039-48d6-b015-19a60629a115",
  "name": "Administración",
  "program_id": "prm_48ec2f25-74e1-406a-a42f-4636bcce7877",
  "workday": true,
  "periodicity": "monthly",
  "payment_plan": 10,
  "amount": 1000,
  "external_id": "123abc",
  "metadata": {
    "id_alumno": "123abc"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.