Zum Inhalt springen
AcrivaDocs

SaveSignatureFields

PUT
/api/v1/t/{tenant}/signatures/requests/{requestId}/fields
curl --request PUT \
  --url https://example.com/api/v1/t/example/signatures/requests/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/fields \
  --header 'Content-Type: application/json' \
  --data '{ "version": 1, "fields": [ { "signer": 1, "page": 1, "x": 1, "y": 1, "width": 1, "height": 1, "kind": "Signature", "purpose": "Name" } ] }'

Parameters

Abschnitt betitelt „ Parameters “

Path Parameters

Abschnitt betitelt „Path Parameters“
tenant
required
string

Tenant slug

requestId
required
string format: uuid

Request Bodyrequired

Abschnitt betitelt „Request Bodyrequired“
Media typeapplication/json
object
version
required
integer format: uint32
fields
required
Array<object> | null
object
signer
required
integer format: int32
page
required
integer format: int32
x
required
number format: double
y
required
number format: double
width
required
number format: double
height
required
number format: double
kind
required
Allowed values: Signature Date Text
purpose
One of:
null

Responses

Abschnitt betitelt „ Responses “

200

Abschnitt betitelt „200“

OK

Media typeapplication/json
object
requestId
required
string format: uuid
state
required
Allowed values: Preparing Review Open Signed Declined Expired Cancelled Failed
version
required
integer format: uint32
pages
required
Array<object>
object
page
required
integer format: int32
cropLeft
required
number format: double
cropBottom
required
number format: double
cropWidth
required
number format: double
cropHeight
required
number format: double
rotation
integer format: int32
0
signers
required
Array<object>
object
position
required
integer format: int32
label
required
string
kind
required
Allowed values: Member Requester External
name
required
null | string
email
required
null | string
detailsFromAi
required
boolean
awaitsConfirmation
required
boolean
fields
required
Array<object>
object
signer
required
integer format: int32
page
required
integer format: int32
x
required
number format: double
y
required
number format: double
width
required
number format: double
height
required
number format: double
kind
required
Allowed values: Signature Date Text
source
required
Allowed values: AcroForm Anchor Keyword Ai Template Manual
confidence
required
number format: double
purpose
One of:
null
Example
{
  "state": "Preparing",
  "pages": [
    {
      "rotation": 0
    }
  ],
  "signers": [
    {
      "kind": "Member"
    }
  ],
  "fields": [
    {
      "kind": "Signature",
      "source": "AcroForm",
      "purpose": "Name"
    }
  ]
}

400

Abschnitt betitelt „400“

Bad Request

Media typeapplication/problem+json
object
type
null | string
title
null | string
status
null | integer format: int32
detail
null | string
instance
null | string
errors
object
key
additional properties
Array<string>
Examplegenerated
{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example",
  "errors": {
    "additionalProperty": [
      "example"
    ]
  }
}

403

Abschnitt betitelt „403“

Forbidden

Media typeapplication/problem+json
object
type
null | string
title
null | string
status
null | integer format: int32
detail
null | string
instance
null | string
Examplegenerated
{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

404

Abschnitt betitelt „404“

Not Found

409

Abschnitt betitelt „409“

Conflict

Media typeapplication/problem+json
object
type
null | string
title
null | string
status
null | integer format: int32
detail
null | string
instance
null | string
Examplegenerated
{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

429

Abschnitt betitelt „429“

Too Many Requests

Media typeapplication/problem+json
object
type
null | string
title
null | string
status
null | integer format: int32
detail
null | string
instance
null | string
Examplegenerated
{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}