Update Recipients

Updates recipients on a sent document in SignWell.

PUT

Query

Field selectionChoose which fields should be included in the response. Learn more

string

Comma-separated response fields to include.

Body

Arguments

stringrequired

array of objectrequired

stringrequired

Updated name for the recipient.

stringrequired

Try this request

Request

curl --request PUT \
  --url "https://connect.mindcloud.co/v1/universal/signWell/latest/actions/update-recipients" \
  --header "Authorization: Bearer $MINDCLOUD_API_TOKEN" \
  --header "Content-Type: application/json" \
  --data '{
  "connectionId": "$CONNECTION_ID",
  "id": "",
  "recipients[]": "",
  "recipients[].id": "",
  "recipients[].name": "",
  "recipients[].email": ""
}'

{
  "success": true,
  "data": [
    {
      "allowDecline": true,
      "allowReassign": true,
      "apiApplicationId": {},
      "applySigningOrder": true,
      "archived": true,
      "createdAt": "string",
      "customRequesterEmail": {},
      "customRequesterName": {},
      "declineMessage": {},
      "declineRedirectUrl": {},
      "embeddedEditUrl": {},
      "embeddedPreviewUrl": "https://example.com",
      "embeddedSigning": true,
      "errorMessage": {},
      "expiresIn": 1,
      "fields[]": {},
      "files[]": {
        "name": "Ava Chen",
        "pagesNumber": 1
      },
      "id": "string",
      "language": "string",
      "message": "string",
      "name": "Ava Chen",
      "recipients[]": {
        "bounced": {},
        "bouncedDetails": {},
        "email": "[email protected]",
        "id": "string",
        "message": {},
        "name": "Ava Chen",
        "passcode": {},
        "placeholderName": "string",
        "sendEmail": true,
        "sendEmailDelay": 1,
        "signingOrder": 1,
        "signingUrl": "https://example.com",
        "status": "string",
        "subject": {}
      },
      "redirectUrl": {},
      "reminders": true,
      "requesterEmailAddress": "[email protected]",
      "status": "string",
      "subject": "string",
      "templateId": "string",
      "testMode": true,
      "updatedAt": "string"
    }
  ],
  "meta": {}
}

Every app you connect,one REST pattern

Call any app with one REST pattern. MindCloud handles each provider's auth, request shape, and responses for you.

Learn what the Universal API is

One REST patternUse the same request structure across apps like Slack, HubSpot, Salesforce, and thousands more.

Managed connectionsSend a MindCloud connection ID instead of handling provider tokens, refresh logic, and credential storage yourself.

Action-level docsEach action page shows the exact endpoint, required arguments, optional controls, and response behavior for that app version.