Groups

Update a group

Updates the specified group by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

Updates the specified group by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

PATCH
/v1/groups/{id}

Authorization

BearerAuth
AuthorizationBearer <token>

Provide your access token in the Authorization header with Bearer auth-scheme. You can view and manage your access tokens in the Certifier Dashboard.

In: header

Path Parameters

id*string

The unique ID of the group

Header Parameters

Certifier-Version*string

API version header. Required for all requests.

Request Body

application/json

name?string

The group's name that is used as [group.name] attribute later on

certificateDesignId?string

The unique certificate design's identifier. At least one of certificateDesignId and badgeDesignId fields is required

badgeDesignId?string

The unique badge design's identifier. At least one of certificateDesignId and badgeDesignId fields is required

learningEventUrl?string

The learning event's URL that is shown in the digital wallet

Formaturi

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X PATCH "https://api.certifier.io/v1/groups/01g90279gp5sbmfek7wymcsvec" \  -H "Certifier-Version: 2022-10-26" \  -H "Content-Type: application/json" \  -d '{}'
{
  "id": "01g90279gp5sbmfek7wymcsvec",
  "name": "Financial Markets",
  "learningEventUrl": "https://www.coursera.org/learn/financial-markets-global",
  "certificateDesignId": "01fpwtztwf7sacca5r0c483mnm",
  "badgeDesignId": "01hz2ej4yzdcfkq9fa78nhyj0x",
  "createdAt": "2022-01-01T00:00:00.000Z",
  "updatedAt": "2022-01-01T00:00:00.000Z"
}

{
  "error": {
    "code": "missing_version",
    "message": "The request is missing the required Certifier-Version header"
  }
}

{
  "error": {
    "code": "unauthorized",
    "message": "A valid authentication token was not provided with the request"
  }
}
{
  "error": {
    "code": "not_found",
    "message": "The requested resource does not exist"
  }
}
{
  "error": {
    "code": "rate_limited",
    "message": "You have exceeded the rate limit"
  }
}
{
  "error": {
    "code": "internal_server_error",
    "message": "There was a problem on Certifier's end"
  }
}