Apply a layout to a document within a specific signing.

PATCH /api/v1/signings/{signingId}/documents/{documentId}

Sample request:

PATCH /api/v1/signings/3fa85f64-5717-4562-b3fc-2c963f66afa6/documents/3fa85f64-5717-4562-b3fc-2c963f66afa7 { "LayoutId": "3fa85f64-5717-4562-b3fc-2c963f66afa8" }

Path parameters

  • signingId string(uuid) Required

    The identifier of the signing to which the document belongs.

  • documentId string(uuid) Required

    The identifier of the document to which the layout is to be applied.

Query parameters

  • LayoutId Required

    Get or Set Layout ID. This property represents the unique identifier of the document layout.

Body

The layout details to be applied.

  • layoutId string(uuid) Required

Body

The layout details to be applied.

  • layoutId string(uuid) Required

Body

The layout details to be applied.

  • layoutId string(uuid) Required

Responses

  • 200

    Success

  • 400

    Bad Request

    Hide response attributes Show response attributes object
    • type string | null
    • title string | null
    • status integer(int32) | null
    • detail string | null
    • instance string | null
    Hide response attributes Show response attributes object
    • type string | null
    • title string | null
    • status integer(int32) | null
    • detail string | null
    • instance string | null
    Hide response attributes Show response attributes object
    • type string | null
    • title string | null
    • status integer(int32) | null
    • detail string | null
    • instance string | null
  • 404

    Not Found

    Hide response attributes Show response attributes object
    • type string | null
    • title string | null
    • status integer(int32) | null
    • detail string | null
    • instance string | null
    Hide response attributes Show response attributes object
    • type string | null
    • title string | null
    • status integer(int32) | null
    • detail string | null
    • instance string | null
    Hide response attributes Show response attributes object
    • type string | null
    • title string | null
    • status integer(int32) | null
    • detail string | null
    • instance string | null
  • default

    Error

    Hide response attributes Show response attributes object
    • code integer(int32)
    • message string | null
    • details array[string] | null
    Hide response attributes Show response attributes object
    • code integer(int32)
    • message string | null
    • details array[string] | null
    Hide response attributes Show response attributes object
    • code integer(int32)
    • message string | null
    • details array[string] | null
PATCH /api/v1/signings/{signingId}/documents/{documentId} 
curl \
 --request PATCH 'https://api.lwolf.com/authentisign/api/v1/signings/{signingId}/documents/{documentId}' \
 --header "Content-Type: application/json" \
 --data '{"layoutId":"string"}'
curl \
 --request PATCH 'https://api.lwolf.com/authentisign/api/v1/signings/{signingId}/documents/{documentId}' \
 --header "Content-Type: text/json"
curl \
 --request PATCH 'https://api.lwolf.com/authentisign/api/v1/signings/{signingId}/documents/{documentId}' \
 --header "Content-Type: application/*+json"
Request examples 
{
  "layoutId": "string"
}
Request examples 
{
  "layoutId": "string"
}
Request examples 
{
  "layoutId": "string"
}
Response examples (400) 
{
  "type": "string",
  "title": "string",
  "status": 42,
  "detail": "string",
  "instance": "string"
}
Response examples (400) 
{
  "type": "string",
  "title": "string",
  "status": 42,
  "detail": "string",
  "instance": "string"
}
Response examples (404) 
{
  "type": "string",
  "title": "string",
  "status": 42,
  "detail": "string",
  "instance": "string"
}
Response examples (404) 
{
  "type": "string",
  "title": "string",
  "status": 42,
  "detail": "string",
  "instance": "string"
}
Response examples (default) 
{
  "code": 42,
  "message": "string",
  "details": [
    "string"
  ]
}
Response examples (default) 
{
  "code": 42,
  "message": "string",
  "details": [
    "string"
  ]
}