TagsApi
All URIs are relative to https://api.esignlaunchpad.com
| Method | HTTP request | Description |
|---|---|---|
| buildTag | GET /api/v1/tags/build | Build a tag in all formats |
| convertTag | POST /api/v1/tags/convert | Convert a tag between formats |
| detectTagFormat | GET /api/v1/tags/detect-format | Detect tag format |
| listTagTypes | GET /api/v1/tags/types | List supported tag types |
| parseTag | POST /api/v1/tags/parse | Parse a tag string |
| validateTag | POST /api/v1/tags/validate | Validate a tag string |
buildTag
TagBuildResponse buildTag(type, signer, required, label, group, options)
Build a tag in all formats
Given an annotation type and signer index, returns the equivalent tag string in Platform, DocuSign, and AdobeSign formats. Use this to generate correctly-formatted tags that you can embed in document content before uploading.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| type | String | The annotation type name (case-insensitive). Must be one of the values returned by `GET /api/v1/tags/types` -- for example `Signature`, `Initials`, `Text`, `Checkbox`, `Dropdown`, etc. | [optional] [default to null] |
| signer | Integer | 1-based signer index that maps to the signer's routing order in the package. Signer 1 is the first signer, signer 2 is the second, and so on. | [optional] [default to null] |
| required | Boolean | Whether the field must be completed before the signer can finish signing. Defaults to `true`. | [optional] [default to true] |
| label | String | Optional human-readable label or tooltip displayed alongside the field in the signing ceremony. | [optional] [default to null] |
| group | String | Optional group name that links related radio buttons or checkboxes together so they behave as a single logical control. | [optional] [default to null] |
| options | String | Comma-separated list of allowed values for Dropdown or RadioGroup fields (e.g. `Yes,No,Maybe`). | [optional] [default to null] |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
convertTag
ConvertTagResponse convertTag(ConvertTagApiRequest)
Convert a tag between formats
Parses a tag in its current format and re-encodes it in the requested target format. For example, convert a DocuSign tag (`\\s1\\`) to the Platform format (`{{sig:1:*}}`) or to AdobeSign format. The source format is auto-detected if not provided. Returns 400 if the source tag cannot be parsed or the target format is invalid.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ConvertTagApiRequest | ConvertTagApiRequest | The request payload containing the tag, target format, and optional source format hint. |
Return type
Authorization
HTTP request headers
- Content-Type: application/json, text/json, application/*+json
- Accept: application/json
detectTagFormat
DetectFormatResponse detectTagFormat(tag)
Detect tag format
Inspects the provided tag string and returns the detected format name (`Platform`, `DocuSign`, or `AdobeSign`). If the string does not match any known format, the `format` field in the response is `null`. This is a lightweight check that does not fully parse the tag -- use `validate` or `parse` for that.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| tag | String | The raw tag string to inspect (e.g. `\s1\` or `{{sig:1:*}}`). | [optional] [default to null] |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
listTagTypes
List listTagTypes()
List supported tag types
Returns every annotation type recognized by the tag parser, along with the short code used in tag syntax, a human-readable description, and a flag indicating whether the type accepts user input during signing (versus auto-populated fields like DateSigned or Name). Use this list to discover valid values for the `type` parameter of the build endpoint.
Parameters
This endpoint does not need any parameter.
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
parseTag
ParsedTagDto parseTag(ParseTagApiRequest)
Parse a tag string
Decomposes a tag string into its annotation type, signer index, required flag, label, and options. If no format is specified in the request, the format is auto-detected. Unlike the `validate` endpoint, this returns 400 if the tag cannot be parsed.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ParseTagApiRequest | ParseTagApiRequest | The request payload containing the tag string and an optional format hint. |
Return type
Authorization
HTTP request headers
- Content-Type: application/json, text/json, application/*+json
- Accept: application/json
validateTag
TagValidationResponse validateTag(ValidateTagApiRequest)
Validate a tag string
Attempts to auto-detect the tag format and parse it into its component parts. Returns a boolean validity flag, the detected format name, and -- when valid -- a breakdown of the annotation type, signer index, required flag, label, and options. Always returns 200; check the `isValid` field in the response to determine whether the tag is well-formed.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ValidateTagApiRequest | ValidateTagApiRequest | The request payload containing the tag string to validate. |
Return type
Authorization
HTTP request headers
- Content-Type: application/json, text/json, application/*+json
- Accept: application/json