Pulse People icon

Pulse People

People resource from Pulse API

Actions8

Overview

This node interacts with the "Person Document" resource of the Pulse API, specifically supporting operations to manage documents related to people. The "Delete Person Document" operation allows users to remove a specific person document by its ID. This is useful in scenarios where outdated or incorrect documents need to be removed from the system to maintain data accuracy and compliance.

Practical example:

  • Automatically deleting expired identity documents from a person's profile during a data cleanup workflow.
  • Removing mistakenly uploaded documents via an automated process triggered by certain conditions.

Properties

Name Meaning
Person Document ID * The unique identifier of the person document that you want to delete. This is a required field.

Output

The output of this operation is a JSON object representing the result of the deletion request. Typically, it will contain confirmation of successful deletion or relevant status information returned by the Pulse API. No binary data is produced by this operation.

Example output structure (conceptual):

{
  "success": true,
  "message": "Person document deleted successfully",
  "deletedDocumentId": "12345"
}

Dependencies

  • Requires an active connection to the Pulse API using an API key credential configured in n8n.
  • The node depends on the Pulse API helper utilities bundled within the node's codebase to perform authenticated requests.
  • Proper permissions on the API key are necessary to allow deletion of person documents.

Troubleshooting

  • Common issues:

    • Providing an invalid or non-existent Person Document ID will likely cause an error indicating the document was not found.
    • Insufficient API permissions can result in authorization errors.
    • Network connectivity problems may cause timeouts or failed requests.

  • Error messages and resolutions:

    • "The operation "deletePersonDocument" is not supported for resource "personDocument"!"
      Ensure the operation and resource names are correctly set in the node parameters.
    • "The resource "personDocument" is not supported!"
      Verify that the resource parameter is set to "personDocument".
    • API error responses indicating missing or invalid credentials require checking the configured API key credential.
    • If the node throws an error about the document ID, confirm that the provided ID exists and is correct.

Links and References

  • Pulse API Documentation (general reference for person document management)
  • n8n Documentation on creating and configuring API credentials
  • Best practices for managing personal documents in automated workflows

Discussion