prepare_co_buyer_invite_resend
Prepare co-buyer invite resend
Prepare resending the co-buyer's signing link for the document awaiting them, optionally correcting their name or email. Returns who the invite would go to, which document, how many invites have been sent against the limit, and what the resend does. Show that to the buyer and ask them. Nothing is sent until resend_co_buyer_invite.
- Effect
- Read
- Required scopes
communications:send- Workflow stages
- closing, offer, transaction
- Data classes
- communications, contacts, offer
- Operation cost
- 1 weighted units; additional domain limits may apply.
- Configurations
- Standard, Buyer UI v2
- Muse proposal
- Read. Retrieves or computes authorized information; consult the tool contract for its scopes and result. Meta makes the final classification during review.
Buyer approval and signing controls apply in addition to the scopes above. Read error and retry guidance before implementing recovery.
Input and output contracts
Returns structured content and a JSON text content block. Live discovery may compact a large output schema; execution validates the full contract below.
Input fields
Required applies within the containing object. Optional fields can be omitted; null is accepted only where listed. Field descriptions and constraints come from the source schema. The raw schema remains the complete contract.
| Field | Required | Meaning and constraints |
|---|---|---|
coBuyerEmailstring | No | Maximum characters: 320. Pattern validation applies; see the raw schema. |
coBuyerNamestring | No | Minimum characters: 1. Maximum characters: 200. |
workspaceIdstring | Yes | Pattern validation applies; see the raw schema. |
Output fields
Required applies within the containing object. Optional fields can be omitted; null is accepted only where listed. Field descriptions and constraints come from the source schema. The raw schema remains the complete contract.
| Field | Required | Meaning and constraints | ||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
expiresAtstring | Yes | Format: date-time. Pattern validation applies; see the raw schema. | ||||||||||||||||||||||||||||||
preparedActionIdstring | Yes | Pattern validation applies; see the raw schema. | ||||||||||||||||||||||||||||||
schemaVersionstring | Yes | Must be "1". | ||||||||||||||||||||||||||||||
statusstring | Yes | Allowed: "prepared", "applied". | ||||||||||||||||||||||||||||||
summaryobject | Yes | Extra fields are not allowed. | ||||||||||||||||||||||||||||||
summary: nested contract
| ||||||||||||||||||||||||||||||||
workspaceIdstring | Yes | Pattern validation applies; see the raw schema. | ||||||||||||||||||||||||||||||
Raw input schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"coBuyerEmail": {
"type": "string",
"maxLength": 320,
"pattern": "^[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\\.[A-Za-z]{2,}$"
},
"coBuyerName": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"workspaceId": {
"type": "string",
"pattern": "^[A-Za-z0-9_-]{1,200}$"
}
},
"required": [
"workspaceId"
],
"additionalProperties": false
}Full output schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"expiresAt": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"preparedActionId": {
"type": "string",
"pattern": "^[A-Za-z0-9_-]{1,200}$"
},
"schemaVersion": {
"type": "string",
"const": "1"
},
"status": {
"type": "string",
"enum": [
"prepared",
"applied"
]
},
"summary": {
"type": "object",
"properties": {
"address": {
"type": "string",
"minLength": 1,
"maxLength": 500
},
"coBuyerEmail": {
"type": "string",
"maxLength": 320,
"pattern": "^[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\\.[A-Za-z]{2,}$"
},
"coBuyerName": {
"type": "string",
"maxLength": 200
},
"correction": {
"type": "boolean"
},
"documentLabel": {
"anyOf": [
{
"type": "string",
"maxLength": 200
},
{
"type": "null"
}
]
},
"effect": {
"type": "string",
"minLength": 1,
"maxLength": 300
},
"inviteSendCount": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"inviteSendLimit": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
}
},
"required": [
"address",
"coBuyerEmail",
"coBuyerName",
"correction",
"documentLabel",
"effect",
"inviteSendCount",
"inviteSendLimit"
],
"additionalProperties": false
},
"workspaceId": {
"type": "string",
"pattern": "^[A-Za-z0-9_-]{1,200}$"
}
},
"required": [
"expiresAt",
"preparedActionId",
"schemaVersion",
"status",
"summary",
"workspaceId"
],
"additionalProperties": false
}Tool annotations
{
"destructiveHint": false,
"idempotentHint": true,
"openWorldHint": false,
"readOnlyHint": true
}Reference 00e5441a095c7e20. Download the full catalog.