Skip to content
Navigation

Updates a certificate's design and copy.

PATCH
https://api.sherpo.io/merchant/v1/stores/{store}/products/{product}/certificates/{certificate}

Authorization

  • bearer
    HTTP
    required

Path parameters

  • store
    string
    required

    The store's id.

  • product
    string
    required

    An id, or slug:<slug>.

    minLength: 1
  • certificate
    string
    required
    minLength: 1

Header parameters

  • Idempotency-Key
    optional
    string

    Repeats within 24 hours answer the first result; the same key with other arguments is a conflict.

    maxLength: 255 · minLength: 1 · pattern: ^[\x21-\x7E]+$

Request body JSON optional

  • settings
    optional
    object
    • requires_passing
      optional
      boolean
    • earned_on
      optional

      completion on a course, attendance (a check-in) on an event.

      One of the following:

      • string
      • null
    • shows
      optional
      array of
      date
      or
      score
      or
      qr_code
    • template
      optional
      classic
      or
      framed
    • accent
      optional

      Null clears it, so it prints in the store's color.

      One of the following:

      • string
      • null
  • headline_copy
    optional
    string
    maxLength: 500 · minLength: 1
  • title_copy
    optional

    One of the following:

    • string
    • null
  • quiz
    optional

    One of the following:

    • object
    • null
  • awarded_copy
    optional

    One of the following:

    • string
    • null
  • reason_copy
    optional

    One of the following:

    • string
    • null
  • score_copy
    optional

    One of the following:

    • string
    • null
  • out_of_score_copy
    optional

    One of the following:

    • string
    • null

Returns

200

Updates a certificate's design and copy.

JSON
  • issued
    number
    required
  • id
    string
    required
  • product_id
    string
    required
  • quiz_id
    required

    One of the following:

    • string
    • null
  • headline_copy
    string
    required
  • title_copy
    required

    One of the following:

    • string
    • null
  • awarded_copy
    required

    One of the following:

    • string
    • null
  • reason_copy
    required

    One of the following:

    • string
    • null
  • score_copy
    required

    One of the following:

    • string
    • null
  • out_of_score_copy
    required

    One of the following:

    • string
    • null
  • settings
    object
    required
    • template
      string
      required
    • accent
      required

      One of the following:

      • string
      • null
    • requires_passing
      optional
      boolean

      Earned by passing the quiz, not by merely finishing it.

    • earned_on
      optional
      string

      Set on a certificate no quiz awards: finishing every entry of a course, or a check-in at an event, earns it; losing its quiz never makes one.

    • shows
      optional
      array of
      string
  • created_at
    required

    One of the following:

    • string
    • null
JSON
  • type
    string
    required
    format: uri
  • title
    string
    required
  • status
    integer
    required
  • detail
    string
    required
  • code
    optional
    string
  • context
    optional
    object
  • reached_core
    optional
    boolean
  • core_answer
    optional
    string

Type to search…

↑↓ navigate↵ selectEsc close