MAmattilda-education
Becas

Actualizar Beca

Actualización de datos de una Beca

put/scholarships/{scholarshipID}

Request

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

Path parameters

scholarshipIDstring required

ID de la beca 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
descriptionstring
apply_to_inscriptionsboolean
apply_to_membershipsboolean
amountinteger
type'integer' | 'percentage'
external_idstring
metadataobject

Campo arbitrario de datos de terceros

Example request

{
  "name": "Beca 5/5",
  "program_id": "prm_1dd999cc-2985-40ee-bb97-0e629320f9b0",
  "description": "Beca de 5% por cada hermano.",
  "apply_to_memberships": true,
  "amount": 1000,
  "type": "integer",
  "external_id": "123abc",
  "metadata": {
    "id_alumno": "123abc"
  }
}

Response

Actualizar Beca

idstring uuid
namestring
descriptionstring
program_idstring
apply_to_inscriptionsboolean
apply_to_membershipsboolean
amountinteger
type'integer' | 'percentage'
status'active' | 'deleted'
external_idstring
metadataobject

Campo arbitrario de datos de terceros

Example response

{
  "id": "d46e023d-44ec-4f92-84a1-9b56cc987e5f",
  "name": "Beca 5/5",
  "description": "Beca de 5% por cada hermano.",
  "program_id": "prm_1dd999cc-2985-40ee-bb97-0e629320f9b0",
  "apply_to_memberships": true,
  "amount": 1000,
  "type": "integer",
  "status": "active",
  "external_id": "123abc",
  "metadata": {
    "id_alumno": "123abc"
  }
}

Changes

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