Sign in
latestOpenAPI 3.0.12026-08-1091181421.2 KB

44eb39b4bd65

Issuers

Update a single Issuer

patch/v2/issuers/{idOrEntityId}

Path parameters

idOrEntityIdstring required

Query parameters

include_staffstring

Request body

badgrDomainstring
descriptionstring required

Short description of the Issuer

emailstring email nullable required

Contact email for the Issuer

extensionsobject
imagestring

Image of the issuer as a base64-encoded data URI. External URLs are not allowed.

namestring nullable required

Name of the issuer

urlstring uri nullable required

Homepage or website associated with the Issuer

Example request

{
  "description": "This is the faculty of the Credentials University.",
  "email": "contact@example.com",
  "image": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mNk+P+/HgAFhQJ/6+gQDQAAAABJRU5ErkJggg==",
  "name": "Credentials Faculty",
  "preferences": {
    "customPropertyDefinitions": [
      {
        "choiceValues": [
          {
            "id": "65663ceb977692fcafcea0b9"
          }
        ],
        "label": "Award Type",
        "propertyId": "66bf8231d88b51901d49d637",
        "propertyType": "STRING_CHOICE",
        "public": true,
        "required": true,
        "subLabel": "Type of award",
        "targetEntityType": "BADGE_CLASS"
      }
    ],
    "defaultPrintCertTemplateId": "5f4e4e4e2dc038241ad01d83",
    "enabledPrintCertTemplateIds": [
      "5f4e4e4e2dc038241ad01d83",
      "6f4e4e4e2dc038241ad01d83"
    ],
    "showOnOrgPublicPage": true
  },
  "staff": [
    {
      "user": "Hey7J-GRSJeu6FNnHQwNyw"
    }
  ],
  "url": "https://example.com"
}

Response

OK

errorCodestring nullable
fieldErrorsobject required
latestTermsVersioninteger nullable
nonFieldErrorsstring[] required
timestampstring date-time nullable
validationErrorsstring[] required
warningsobject required

Example response

{
  "result": [
    {
      "badgeSkillLinkingPreferences": {
        "indeedRegion": "us",
        "serverUri": "https://example.com/",
        "type": "TALENT_NEURON"
      },
      "badgrDomain": "badgrsupportgroup.badgr.com",
      "description": "This is the faculty of the Credentials University.",
      "email": "contact@example.com",
      "entityId": "Uu4wd2I1SKmD3vmtMJ19hw",
      "entityType": "Issuer",
      "id": "6016c84d1ff787222b6c4d15",
      "image": "https://api.badgr.ws/public/issuers/Uu4wd2I1SKmD3vmtMJ19hw/image",
      "imagePath": "uploads/issuers/issuer-JTdhRmlFQZScIjoUr6x4UQ.png",
      "name": "Credentials Faculty",
      "openBadgeId": "https://api.badgr.ws/public/issuers/Uu4wd2I1SKmD3vmtMJ19hw",
      "organizationId": "6f4e4e4e2dc038241ad01d83",
      "originalJson": "{}",
      "preferences": {
        "customPropertyDefinitions": [
          {
            "choiceValues": [
              {
                "id": "65663ceb977692fcafcea0b9"
              }
            ],
            "label": "Award Type",
            "propertyId": "66bf8231d88b51901d49d637",
            "propertyType": "STRING_CHOICE",
            "public": true,
            "required": true,
            "subLabel": "Type of award",
            "targetEntityType": "BADGE_CLASS"
          }
        ],
        "defaultPrintCertTemplateId": "5f4e4e4e2dc038241ad01d83",
        "enabledPrintCertTemplateIds": [
          "5f4e4e4e2dc038241ad01d83",
          "6f4e4e4e2dc038241ad01d83"
        ],
        "showOnOrgPublicPage": true
      },
      "source": "local",
      "sourceUrl": "https://example.com/issuers/1",
      "staff": [
        {
          "user": "Hey7J-GRSJeu6FNnHQwNyw",
          "userProfile": {
            "agreedTermsVersion": 4,
            "badgrDomain": "badgrsupportgroup.badgr.com",
            "emails": [
              {
                "email": "Jane.Doe@example.com"
              }
            ],
            "entityId": "Hey7J-GRSJeu6FNnHQwNyw",
            "entityType": "BadgeUser",
            "firstName": "Jane",
            "lastName": "Doe",
            "marketingOptIn": true
          }
        }
      ],
      "url": "https://example.com"
    }
  ],
  "status": {
    "description": "ok"
  }
}