Blue icon

Blue

Interact with Blue Project Management via GraphQL API

Actions10

Invite User

AI-generated

Overview

This node operation invites a user to a specified project within a company on the Blue Project Management platform. It allows setting the user's email and assigning a role, including predefined roles like Admin, Client, Member, Owner, and custom roles defined in the project. This operation is useful for automating user management and access control in project collaboration workflows.

Use Case Examples

  1. Invite a new team member to a project with a Member role to collaborate on tasks.
  2. Add a client user with limited access to view project progress and add comments.
  3. Assign a custom role to a user based on specific project permissions.

Properties

Name Meaning
Company The company containing the records or projects where the user will be invited. It can be selected from a list or specified by ID.
Project The project to which the user will be invited. It is optional for some operations but required for inviting a user. Can be selected from a list or specified by ID.
Email The email address of the user to invite to the project.
Role The role to assign to the invited user, determining their access level within the project. Options include Admin, Client, Comment Only, Custom Role, Member, Owner, and View Only.
Custom Role Name or ID The custom role to assign to the user if the 'Custom Role' option is selected. It can be chosen from a list or specified by ID using an expression.
Additional Options Optional settings including request timeout in milliseconds and whether to return the full GraphQL response including errors and extensions.

Output

JSON

  • json - The JSON output contains the result of the invite user operation, including success status and any returned data or error messages.

Dependencies

  • Blue Project Management GraphQL API
  • An API key credential for authentication

Troubleshooting

  • Ensure the companyId and projectId are correctly specified and accessible with the provided API credentials.
  • Verify the email address format is valid and the user is not already invited.
  • If using a custom role, confirm the role ID is valid and exists in the project.
  • Check network connectivity and API endpoint availability.
  • Common errors include GraphQL errors returned from the API, which may indicate permission issues or invalid input parameters. Review error messages for details and adjust inputs accordingly.

Links

Discussion