API Reference

Partially update a certificate

patch
https://vertex-enterprise-group.readme.io/certificate-center/v1/certificate/

Update only the supplied fields of the certificate with the given UUID.

  • Omitted fields are unchanged; supplied values replace the current value.
  • Arrays and objects are replaced in full.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
uuid
required
Body Params

Update only the supplied fields of the certificate with the given UUID.

  • Omitted fields are unchanged; supplied values replace the current value.
  • Arrays and objects are replaced in full.

date

On or after customer start date.

date

On or after start date and on or before customer end date.

string
enum
Allowed:
string
enum
string
enum
Allowed:
string
enum
Allowed:
transactionTypes
array of objects
transactionTypes
Allowed:
customFields
array of objects

Custom fields are user-defined. See Certificate Custom Field Configuration API for details.

customFields
contact
object
coverages
array of objects
coverages
specialConditionCategory
object

Required when class is 'Special Condition'.

string
length between 1 and 140
.*\S.*

Notes must be less than or equal to 140 characters.

string
length between 1 and 50
.*\S.*

Required when scope is 'Single-Use'. DocumentNumber must be less than or equal to 50 characters.

customer
object
taxabilityDrivers
array of objects
taxabilityDrivers
seller
object

Limited by selected customer taxpayer.

Responses
200

OK

Updated about 2 months ago

Did this page help you?
Language
URL
LoadingLoading…
Response
Choose an example:
application/json

Updated about 2 months ago

Did this page help you?