Signatures

Update a signature

Promotes it to default, replaces its image, or both. isDefault: false is a no-op — a user who owns signatures always has exactly one default, so the way to move it is to promote another. Replacing the image leaves already-signed documents untouched, since the image is copied into each submission at signing time.

patch/v1/users/me/signatures/{id}

Request

  • Base URL: https://api.signvoy.com
  • URL: https://api.signvoy.com/v1/users/me/signatures/{id}
  • Auth: HTTP bearer

Path parameters

idstring uuid required

Request body

isDefaultboolean

Pass true to make this the default. Passing false is a no-op: a user always has a default while they have any signatures.

source'draw' | 'type'

How the replacement image was produced. Required with dataUrl.

dataUrlstring

Replacement image as a base64 PNG data URL. Required with source.

typedNamestring

The name that was typed. Required when source is 'type'.

fontKey'caveat' | 'dancing-script' | 'sacramento' | 'great-vibes' | 'homemade-apple' | 'allura' | 'parisienne'

Font the name was rendered in. Required when source is 'type'.

Response

idstring uuid required
source'draw' | 'type' required

How the signature was produced

dataUrlstring required

The signature image as a base64 PNG data URL

typedNamestring nullable required

The name that was typed. Only set when source is 'type'.

fontKeystring nullable required

Font the name was rendered in, keyed to SIGNATURE_FONTS. Only set when source is 'type'.

isDefaultboolean required

Offered first when signing. At most one per user.

createdAtstring date-time required
updatedAtstring date-time required

Example response

{
  "dataUrl": "data:image/png;base64,iVBORw0KGgo..."
}

Changes

No recorded changes to this operation across all 1 revision of this API.