Assignments

Estimate resend cost

Changed on

Estimate the cost of resending the signature request to a signer. The response has its own shape (total, not total_credits), because a reminder uses no document.

Copy as Markdown Open in ChatGPT Open in Claude

post/v1/documents/{documentId}/assignments/{assignmentId}/signers/{signerId}/estimate-resend-cost

Request

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

Path parameters

documentIdstring required

Document ID.

assignmentIdstring required

The assignment ID.

signerIdstring required

The signer ID.

Response

Cost estimate

statusinteger

HTTP status code, mirrored in the body.

messagestring

Human-readable message; empty on success.

Example response

{
  "status": 200,
  "data": {
    "total": 0.45,
    "breakdown": [
      {
        "code": "NotificationWhatsappResend",
        "name": "Whatsapp Notification Resend",
        "cost": 0.45
      }
    ],
    "credit_balance": 10,
    "has_sufficient_credits": true
  }
}

Changes

    • breaking

      the response property // became nullable for the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property //// from the response with the status

    • warning

      removed the optional property //// from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • info

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

    • info

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