Actions87
- Users Actions
- Shopping & Catalogs Actions
- Advertising & Campaigns Actions
- Advanced Analytics Actions
- Engagement Features Actions
- Business Tools Actions
- Search & Discovery Actions
- Pins Actions
- Boards Actions
Overview
The "Invite Board Collaborator" operation in the Boards resource allows users to invite a collaborator to a specific Pinterest board. This is useful for teams or groups managing shared boards, enabling multiple users to contribute content, manage pins, and collaborate on board curation.
Practical scenarios include:
- Marketing teams inviting members to collaborate on campaign boards.
- Content creators sharing boards with partners or clients for joint management.
- Community managers adding contributors to group boards.
This operation streamlines collaboration by programmatically sending invitations to users to join a board as collaborators.
Properties
| Name | Meaning |
|---|---|
| Include Private Metrics | Boolean flag to include private metrics in the response (requires elevated access). |
| Custom Fields | Comma-separated list of custom fields to include in the response for extended data. |
Note: For this specific operation ("Invite Board Collaborator"), the node expects parameters related to identifying the board and the user to invite, but these are not explicitly listed in the provided properties snippet. The general properties above apply across resources including boards.
Output
The output JSON contains the result of the invitation request to add a collaborator to a board. It typically includes confirmation details such as the invited user's information, invitation status, and any metadata returned by the Pinterest API regarding the collaboration invite.
If the operation fails, the output may contain an error message describing the failure reason.
No binary data output is associated with this operation.
Dependencies
- Requires an active subscription and valid API key credential for the external "N8N Tools API" service that acts as a proxy or enhancer for Pinterest API v5.
- Requires OAuth2 authentication credentials for Pinterest API access.
- The node uses several internal API wrapper classes for different Pinterest API domains; for this operation, it uses the Engagement Features API wrapper.
- Proper configuration of these credentials in n8n is necessary for successful execution.
Troubleshooting
- Invalid Subscription or API Key: If the node throws an error about invalid subscription or API key, verify that the API key credential is correctly configured and active.
- Permission Errors: Inviting collaborators requires appropriate permissions on the board. Ensure the authenticated user has rights to invite collaborators.
- Missing Parameters: Ensure all required parameters like board ID and user identifier (email or username) are provided.
- API Rate Limits: Frequent requests might hit rate limits; handle errors accordingly and implement retries if needed.
- Continue On Fail: The node supports continuing execution on individual item failures, which can help process bulk invites without stopping on errors.
Links and References
- Pinterest API v5 Documentation
- Pinterest Boards API Reference
- n8n Documentation - Creating Custom Nodes
Note: The exact input parameters for the "Invite Board Collaborator" operation (such as board ID and collaborator user info) are expected to be part of the node's UI but were not detailed in the provided property definitions or code snippet. They should be configured according to the Pinterest API requirements for inviting collaborators.