Assignments

Reset assignment expiration

Changed on

Set a new expiration date for an assignment, or remove its expiration by sending expires_at: null. Not allowed once the document is closed.

Copy as Markdown Open in ChatGPT Open in Claude

put/v1/documents/{documentId}/assignments/{assignmentId}/reset-expiration

Request

  • Base URL
    https://api.assinafy.com.br
  • URL
    https://api.assinafy.com.br/v1/documents/{documentId}/assignments/{assignmentId}/reset-expiration
  • Auth
    • HTTP bearer
    • or API key in header X-Api-Key

Path parameters

documentIdstring required

Document ID.

assignmentIdstring required

The assignment ID.

Request body

expires_atstring date-time nullable required

New expiration date (ISO 8601). Must be at least one hour in the future. Send null to remove the expiration — the key itself is required. A UTC offset in the value is honored (2026-12-31T23:59:59-03:00 is 2027-01-01T02:59:59Z); a value without one is read as UTC, and a date alone (2026-12-31) means 23:59 UTC that day.

Example request

{
  "expires_at": "2026-12-31T23:59:59Z"
}

Response

The updated assignment

statusinteger

HTTP status code, mirrored in the body.

messagestring

Human-readable message; empty on success.

Example response

{
  "status": 200,
  "data": {
    "resource": "assignment",
    "id": "615606ef81d199996981dbce",
    "document_id": "615601fab04c0a3147bb1246",
    "created_at": "2026-06-03T03:54:16Z",
    "sender_email": "sender@example.com",
    "method": "virtual",
    "signers": [
      {
        "resource": "signer",
        "id": "62d6ee35c7741ca4006b9e11",
        "full_name": "John Signer",
        "email": "john@email.com",
        "whatsapp_phone_number": "+5548999990000",
        "government_id": "39053344705",
        "verification_method": "Email",
        "notification_methods": [
          "Email"
        ],
        "step": 1,
        "identity_verification_status": "InReview",
        "notification_history": [
          {
            "event": "signature_request",
            "status": "sent",
            "sent_at": "2026-07-07T12:00:00Z"
          }
        ]
      }
    ],
    "items": [
      {
        "page": {
          "id": "615601faf166d6d1d8e7dc30",
          "number": 1,
          "height": 2100,
          "width": 1275,
          "download_url": "https://api.assinafy.com.br/v1/documents/doc1/pages/1a/download"
        }
      }
    ],
    "signing_urls": [
      {
        "url": "https://api.assinafy.com.br/v1/sign/doc1?email=joe@example.com"
      }
    ]
  }
}

Changes

  • f7da81a5567eRevision changes
    • breaking

      the response property // became nullable for the status

  • dda5f0d393cbRevision changes
    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status