Remind signers

Email a reminder to signers who haven't signed yet (with sequential signing, only the current signing-order group), or to one recipient.

POST https://api.centerfy.ai/webhooks/inbound/contracts/:id/remind

Headers

Header	Required	Value	Description
`x-api-key`	Yes	your sub-account API key (cfy_…)	Authenticates the request; or use Authorization: Bearer `<key>`.

Path parameters

Name	Type	Required	Description
`id`	`string (uuid)`	Yes	The contract id.

Body parameters

Name	Type	Required	Default	Description
`recipient_id`	`string (uuid)`	No	—	Remind only this recipient.
`base_url`	`string (https URL)`	No	—	Origin for the signing links, e.g. your white-label app domain. Only the origin is used; must be https. Defaults to the origin used when the contract was sent.

Request body

{
  "recipient_id": "7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d"
}

Example

curl -X POST "https://api.centerfy.ai/webhooks/inbound/contracts/{id}/remind" \
  -H "x-api-key: $CENTERFY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "recipient_id": "7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d"
}'

import { CenterfyClient } from "@centerfy/sdk";

const centerfy = new CenterfyClient({ apiKey: process.env.CENTERFY_API_KEY! });

const result = await centerfy.contracts.remind("<contractId>", {
  "recipient_id": "7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d"
});
console.log(result);

centerfy contracts remind <contractId> '{"recipient_id":"7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d"}'

MCP tool: centerfy_contracts_remind (see MCP server)

Response

{
  "status": "success",
  "contract_id": "c1d2e3f4-a5b6-4c7d-8e9f-0a1b2c3d4e5f",
  "action": "remind",
  "results": [
    {
      "email": "[email protected]",
      "success": true
    }
  ]
}

Errors

409 — unless the contract is sent, viewed or partially_signed, if no signers are pending, or if that recipient can’t be reminded right now (already signed or waiting on an earlier signer).
400 — if recipient_id is not a UUID or base_url is invalid.
404 — if the contract or recipient is not in this sub-account.

Notes

The body is optional. Check results — a reminder can return 200 even if an individual email failed.