PUT /v1/signature/envelopes/{id}/fields
const url = 'https://api.asap.cool/v1/signature/envelopes/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/fields';const options = { method: 'PUT', headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'}, body: '{"fields":[{"anchor_kind":"example","field_type":"example","height":1,"page":1,"pos_x":1,"pos_y":1,"required":true,"signer_id":"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0","value":"example","width":1}]}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request PUT \ --url https://api.asap.cool/v1/signature/envelopes/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/fields \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data '{ "fields": [ { "anchor_kind": "example", "field_type": "example", "height": 1, "page": 1, "pos_x": 1, "pos_y": 1, "required": true, "signer_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "value": "example", "width": 1 } ] }'Authorizations
Section intitulée « Authorizations »Parameters
Section intitulée « Parameters »Path Parameters
Section intitulée « Path Parameters »Envelope identifier.
Request Body required
Section intitulée « Request Body required »Body of PUT …/fields: the full field set to persist.
object
The fields to place (replaces any existing set).
One positioned field in a PUT …/fields request.
The fractional geometry is persisted at 4-decimal precision (NUMERIC(6,4),
i.e. ~10⁻⁴ of the page), so a coordinate with more decimals is rounded on
store and the GET/response reflects the rounded value. 4 decimals is well
below one pixel at any realistic page size.
object
Auto-placement source, if any.
Field kind (signature/date/initials/text/checkbox/
signer_name/signer_email/mention/radio).
Height as a fraction of page height (0, 1].
1-based page index.
Left edge as a fraction of page width [0, 1].
Top edge as a fraction of page height [0, 1].
Whether the field is required (defaults to true).
The signer this field is assigned to (must belong to the envelope).
Optional default/typed value.
Width as a fraction of page width (0, 1].
Example generated
{ "fields": [ { "anchor_kind": "example", "field_type": "example", "height": 1, "page": 1, "pos_x": 1, "pos_y": 1, "required": true, "signer_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "value": "example", "width": 1 } ]}Responses
Section intitulée « Responses »Fields replaced.
Public projection of a [Field].
object
Auto-placement source, if any.
Field kind.
Height fraction (0, 1].
Stable identifier.
1-based page index.
Left edge fraction [0, 1].
Top edge fraction [0, 1].
Whether the field is required.
The signer this field is assigned to.
Optional default/typed value.
Width fraction (0, 1].
Example generated
[ { "anchor_kind": "example", "field_type": "example", "height": 1, "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "page": 1, "pos_x": 1, "pos_y": 1, "required": true, "signer_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "value": "example", "width": 1 }]No active org.
Generic error body returned by API handlers when they fail. code is a
stable machine-readable token; message is human-friendly and meant for
surfacing to end users.
object
Stable machine token (e.g. invalid_credentials).
Offending request field for validation errors, when known.
Human-readable message.
Example generated
{ "code": "example", "field": "example", "message": "example"}Missing signature:write scope.
Generic error body returned by API handlers when they fail. code is a
stable machine-readable token; message is human-friendly and meant for
surfacing to end users.
object
Stable machine token (e.g. invalid_credentials).
Offending request field for validation errors, when known.
Human-readable message.
Example generated
{ "code": "example", "field": "example", "message": "example"}Not found or cross-org.
Generic error body returned by API handlers when they fail. code is a
stable machine-readable token; message is human-friendly and meant for
surfacing to end users.
object
Stable machine token (e.g. invalid_credentials).
Offending request field for validation errors, when known.
Human-readable message.
Example generated
{ "code": "example", "field": "example", "message": "example"}Envelope is not a draft (signature_conflict).
Generic error body returned by API handlers when they fail. code is a
stable machine-readable token; message is human-friendly and meant for
surfacing to end users.
object
Stable machine token (e.g. invalid_credentials).
Offending request field for validation errors, when known.
Human-readable message.
Example generated
{ "code": "example", "field": "example", "message": "example"}Invalid field geometry or signer.
Generic error body returned by API handlers when they fail. code is a
stable machine-readable token; message is human-friendly and meant for
surfacing to end users.
object
Stable machine token (e.g. invalid_credentials).
Offending request field for validation errors, when known.
Human-readable message.
Example generated
{ "code": "example", "field": "example", "message": "example"}