Actions33
- Activity Actions
- Contact Actions
- Group Actions
- Membership Actions
- Relationship Actions
- Custom API Call Actions
Relationship → Delete
AI-generatedSummary
Deletes a CiviCRM Relationship by its internal ID, returning confirmation details.
Inputs
- id (required) — The internal CiviCRM ID of the relationship to delete.
- runtimeBearerToken — A JWT token for a specific real user; if provided, it is used as the Authorization header and no fallback to the credential's API key occurs.
- baseUrlOverride — Optional Base URL for the CiviCRM instance (site root without /civicrm).
Output shape
An object containing success status, a confirmation message, the deleted ID, and the raw API response.
The operation always returns a success record; errors (e.g., permission denied) are reported in the raw API response within the output.
Examples
Example 1: Remove a specific relationship by ID.
Set Resource to 'Relationship', Operation to 'Delete', and enter the Relationship ID in the 'ID' field.
Example 2: Delete a relationship on behalf of a specific user using a pre-issued JWT.
Provide the user's JWT in the 'Runtime Bearer Token' field to bypass credential authentication.