---
title: "Edit a certificate outline"
method: PATCH
path: "/api/v2/certificate-outlines/{certificateOutlineId}"
tags: ["Certificate Outlines"]
---

# Edit a certificate outline

`PATCH /api/v2/certificate-outlines/{certificateOutlineId}`

> 🔑
>
> Required OAuth scope: `certificateOutlines:write`.

Edits specific fields of an existing certificate outline. Fields not included in the request payload remain unchanged.

## Path parameters

- `certificateOutlineId` string, ObjectId, required

## Headers

- `360-api-version` 'v2.0', required

## Request body

- PatchCertificateOutlineDTO
  - `title` string — The title of the certificate outline.
  - `groupId` string, ObjectId — The unique ID of the group this outline belongs to.
  - `bodyHtml` string — The content of the certificate outline. Can contain tags which will dynamically be replaced when delivering a certificate. Available tags are: [person_first_name], [person_last_name], [person_email], [person_organization], [authenticity_verification_url], [credits_acquired], [delivery_date], [path_session_title], [path_title], [reference_number], [score_reached], [start_date], [time_spent], [validity_period].
  - `authenticityVerificationUrlWording` string, nullable — A wording to display the authenticity verification URL. If set, it needs to contain [authenticity_verification_url] tag.
  - `backgroundImageId` string, ObjectId, nullable — The media unique ID of the background image for this outline.
  - `logoImageId` string, ObjectId, nullable — The media unique ID of the logo to display at the top of the certificate.
  - `referenceNumberWording` string, nullable — A wording to display the reference number. If set, it needs to contain [reference_number] tag.
  - `subtitle` string, nullable — The subtitle of the certificate outline.
  - `validityPeriod` integer, nullable — Number of months of validity of the certificate.
  - `validityPeriodWording` string, nullable — A wording to display the validity period. If set, it needs to contain [validity_period] tag.

## Response `200`

Returns the updated certificate outline.

- CertificateOutlineResponseDTO
  - `title` string, required — The title of the certificate outline.
  - `groupId` string, ObjectId, required — The unique ID of the group this outline belongs to.
  - `_id` string, ObjectId, required — The unique ID of the certificate outline.
  - `createdAt` string, date-time, required — The date and time when the certificate outline was created, in the `YYYY-MM-DDThh:mm:ss.sssZ` format (ISO 8601 in Coordinated Universal Time (UTC)).

## Other responses

- `400` — The server cannot or will not process the request due to something that is perceived to be a client error.
- `401` — The given access token is either missing, invalid, has expired, or has been revoked.
- `403` — The given access token does not have the required OAuth scope to execute the request.
- `404` — The server cannot find the requested resource.
- `429` — The client has sent too many requests in a short amount of time.

---

[API](https://skmtc.net/360learning/apis/core-api.md) · [All operations](https://skmtc.net/360learning/apis/core-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/360learning/core-api/revisions/94b691b0b72c/schema)