Earner

Assign an Earner to the Earners List

Assigns an Earner to the existing Earners List.

POST: /api/v1/issuers/organization/earners_lists/earners

Required parameters

recipient_email: Earners email address.
recipient_first_name: Earners first name.
recipient_last_name: Earners last name.
earners_list_id: Specific Earners list ID.

{
  "earners_list_id": "e568673d-d5bb-4576-a591-766b3f11aa5e",
  "recipient_email": "puree@open-badge.eu",
  "recipient_first_name": "Galla",
  "recipient_last_name": "Billa",
  "metadata": null
}

{
    "data": {
        "id": "e4a2373d-d5bb-4576-a591-766b3f11aa5e",
        "recipient_email": "puree@open-badge.eu",
        "recipient_first_name": "Galla",
        "recipient_last_name": "Billa",
        "metadata": null,
        "created_at": "2024-09-16T15:35:49.000000Z",
        "updated_at": "2024-09-16T15:35:49.000000Z",
        "email_verified_at": null
    }
}

Update an Earner in the Earners List

Updates an Earner an existing Earners List

PUT: api/v1/issuers/organization/earners_lists/earners/{earner_id}

{
  "earners_list_id": "e568673d-d5bb-4576-a591-766b3f11aa5e",
  "recipient_first_name": "Giovanni",
  "recipient_last_name": "Billa"
}

{
    "data": {
        "id": "74f0f6a6-763d-4015-9be2-2a809aaada2c",
        "recipient_email": "test.z@open-badge.eu",
        "recipient_first_name": "new",
        "recipient_last_name": "test",
        "created_at": "2024-06-24T13:36:04.000000Z",
        "updated_at": "2024-06-24T13:36:04.000000Z",
        "email_verified_at": null
    }
}

{
    "message": "EarnersListUserEmail does not exist or you do not the the permission to access it."
}

Last modified: 12 November 2024