nBold (Preview)
Teams Template and Creation Automation with Channels, Files Template, Folder structure, Planner template with tasks; Governance Automation for Microsoft Teams.
This connector is available in the following products and regions:
| Service | Class | Regions |
|---|---|---|
| Copilot Studio | Premium | All Power Automate regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD) |
| Logic Apps | Standard | All Logic Apps regions except the following: - Azure Government regions - Azure China regions - US Department of Defense (DoD) |
| Power Apps | Premium | All Power Apps regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD) |
| Power Automate | Premium | All Power Automate regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD) |
| Contact | |
|---|---|
| Name | nBold Support |
| URL | https://docs.nbold.co/api |
| support@nbold.co |
| Connector Metadata | |
|---|---|
| Publisher | nBold |
| Website | https://nbold.co |
| Privacy policy | https://nbold.co/legal/privacy |
| Categories | Productivity;IT Operations |
nBold Connector
Overview
The nBold connector let you build automation with teams, channels, sites, planner and more to streamline collaboration, and better govern your collaboration environment. nBold let's you build teams templates with channels, Files templates, Folder structures, Planner board and more; Automate the creation of teams from templates at scale.
Features
- Create Teams from Template: create new team with Channels, Files, Folders, Planner, lists and more.
- Approve or Reject Team Requests: Approve or Reject team creation requests
- Manage Teams: Retrieve team details, archive teams, and access collaboration templates.
- Security & Compliance: Ensure proper governance and compliance across Microsoft Teams.
Prerequisite
You will need the following
- A Microsoft Power Apps or Power Automate premium plan for 1 account only.
- A valid Trial or a Paid subscription to nBold.
- nBold installed and connected to your tenant.
Authentication
This connector requires OAuth authentication. To obtain credentials:
- Go to the connector and sign-in.
- Give the consent to the app
- Everything is working
Operations
Triggers
- When a Team Creation Approval is Requested: Triggers when a team creation approval request is submitted.
- When a Team Creation is Approved: Triggers when a team creation request is approved.
- When a Team Creation is Rejected: Triggers when a team creation request is rejected.
- When a Team is Created Using a Collaboration Template: Triggers when a team is successfully created from a collaboration template.
Actions
- Create a Team Based on a Collaboration Template: Creates a new team using a predefined collaboration template.
- Retrieve Templates: Fetches a list of available collaboration templates.
- Get Team Details: Retrieves details of a specific team.
- Archive a Team: Archives a team to restrict activity.
- Unarchive a Team: Restores an archived team to active status.
- Invite a Member in a Team: Adds a new member to a specified team.
- Get the Channels of a Team: Retrieves all channels within a team.
- Create a Channel in a Team: Creates a new channel in a specified team.
- Get the Primary Channel of a Team: Fetches the default primary channel of a team.
- Create a Tab in a Team Channel: Adds a tab to a specific channel in a team.
For more details, visit nBold API Documentation.
Creating a connection
The connector supports the following authentication types:
| Default | Parameters for creating connection. | All regions | Not shareable |
Default
Applicable: All regions
Parameters for creating connection.
This is not shareable connection. If the power app is shared with another user, another user will be prompted to create new connection explicitly.
Throttling Limits
| Name | Calls | Renewal Period |
|---|---|---|
| API calls per connection | 100 | 60 seconds |
Actions
| Approval for team provisioning |
The approval of team provisioning |
| Approve a team request (Preview) |
This endpoint allows an admin or authorized user to approve a team request based on the provided team ID. The approval action will update the team status to approved. |
| Archive a Team (Preview) |
Archive a team. |
| Create a Channel in a Team (Preview) |
Create a new team channel. |
| Create a Tab in a Team Channel (Preview) |
Create a new tab in a team channel. |
| Create a Team Based on a Collaboration Template (Preview) |
Create a team provisioning job based on a collaboration template. This template may include files, folders, Planner tasks, private channels... |
| Generate a Signature for a Webhook (Preview) |
Generate a signature from a secret and a webhook payload. |
| Get a Team (Preview) |
Get detailed information about a team. |
| Get My Teams Collaboration Templates (Preview) |
Get the teams collaboration templates accessible to the connected user filtered by the audience targeting rules. |
| Get the Channels of a Team (Preview) |
Get all the channels of a team. |
| Get the Primary Channel of a Team (Preview) |
Get the primary channel of a team. |
| Invite a Member in a Team (Preview) |
Invite a team member as a member or an owner. |
| Reject a Team Creation Request (Preview) |
Reject a team creation request. |
| Unarchive a Team (Preview) |
Unarchive a team. |
Approval for team provisioning
The approval of team provisioning
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Template ID
|
id | True | string |
The unique identifier of the template. |
|
Template Name
|
templateName | string |
The name of the template. |
|
|
Name
|
name | True | string |
The name of the team. |
|
Description
|
description | string |
The description of the team. |
|
|
Welcome Message
|
welcomeMessage | string |
The welcome message for the team. |
|
|
Members
|
Members | object | ||
|
Owners
|
Owners | object | ||
|
Metadata
|
metadata | object |
Additional metadata for the approval request. |
Returns
Response for team approval.
- Approval Response
- object
Approve a team request (Preview)
This endpoint allows an admin or authorized user to approve a team request based on the provided team ID. The approval action will update the team status to approved.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Approval Request
|
approvalRequestId | True | string |
The ID of the approval request you want to approve. |
|
ID
|
id | True | string |
Impersonate the approver by specifying a User ID. If empty, you'll be automatically assigned as the approver. |
|
Message
|
message | string |
Message to be sent to the requester. |
|
|
Name
|
name | string |
Overrides the team name defined by the requester. |
|
|
Description
|
description | string |
Overrides the team description defined by the requester. |
|
|
Welcome Message
|
welcomeMessage | string |
Overrides the welcome message defined by the requester. |
Returns
Response for approval request.
- Approval Request Body
- object
Archive a Team (Preview)
Archive a team.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Team
|
teamId | True | string |
The team ID. |
|
Defines whether to set permissions for team members to read-only on the SharePoint Online site associated with the team
|
shouldSetSpoSiteReadOnlyForMembers | boolean |
Defines whether to set permissions for team members to read-only on the SharePoint Online site associated with the team. |
Returns
Team Archiving Body.
- Team Archiving
- object
Create a Channel in a Team (Preview)
Create a new team channel.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Team
|
teamId | True | string |
The team ID. |
|
display name
|
displayName | True | string |
The name of the channel |
|
description
|
description | string |
A brief description of the channel |
|
|
type membership
|
membershipType | True | string |
The type of membership for the channel (e.g., standard or private) |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
OData metadata URL
|
@odata.context | uri |
OData context URL |
|
ID
|
id | string |
Unique identifier of the channel |
|
Creation date
|
createdDateTime | date-time |
Timestamp when the channel was created |
|
Name
|
displayName | string |
The name of the channel |
|
Description
|
description | string |
A brief description of the channel |
|
Favorite by default
|
isFavoriteByDefault | boolean |
Indicates whether the channel is favorited by default |
|
Email
|
string |
The email address associated with the channel (if applicable) |
|
|
Web link
|
webUrl | uri |
The web URL to access the channel |
|
Membership type
|
membershipType | string |
The type of membership for the channel |
|
Archive status
|
isArchived | boolean |
Indicates whether the channel is archived |
Create a Tab in a Team Channel (Preview)
Create a new tab in a team channel.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Team
|
teamId | True | string |
The team ID. |
|
Channel
|
channelId | True | string |
The team channel ID. |
|
Tab name
|
displayName | True | string |
The name of the tab |
|
Teams app binding URL
|
teamsApp@odata.bind | True | uri |
The OData bind URL for the Teams app to be associated with the tab |
|
Tab entity ID
|
entityId | string |
Unique identifier for the tab content |
|
|
Tab content URL
|
contentUrl | uri |
The URL that loads the tab content |
|
|
Tab website URL
|
websiteUrl | uri |
The website URL associated with the tab |
|
|
Tab removal URL
|
removeUrl | uri |
The URL to remove/uninstall the tab |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
ID
|
id | string |
Team Channel Tab ID |
|
Display Name
|
displayName | string |
Team Channel Tab Display Name |
|
ID
|
configuration.entityId | string |
Configuration Entity ID |
|
Content URL
|
configuration.contentUrl | string |
Configuration Content URL |
|
Website URL
|
configuration.websiteUrl | string |
Configuration Website URL |
|
Remove URL
|
configuration.removeUrl | string |
Configuration Remove URL |
|
ID
|
teamsApp.id | string |
Team Channel Tab Teams App ID |
|
External ID
|
teamsApp.externalId | string |
Team Channel Tab Teams App External ID |
|
Display Name
|
teamsApp.displayName | string |
Team Channel Tab Teams App Display Name |
|
Distribution Method
|
teamsApp.distributionMethod | string |
Team Channel Tab Teams App Distribution Method |
|
Sort Order Index
|
sortOrderIndex | string |
Team Channel Tab Sort Order Index |
|
Web URL
|
webUrl | string |
Team Channel Tab Web URL |
Create a Team Based on a Collaboration Template (Preview)
Create a team provisioning job based on a collaboration template. This template may include files, folders, Planner tasks, private channels...
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Collaboration Template
|
id | True | string |
The collaboration template ID |
|
Team Name
|
name | string |
Requested team name |
|
|
Team Description
|
description | string |
Requested team description |
|
|
Team Welcome Message
|
welcomeMessage | string |
Requested team welcome message |
|
|
Team member ID
|
id | string |
Team member ID. |
|
|
Owner ID
|
id | string |
Team owner ID |
|
|
Metadata
|
metadata | object |
Additional metadata as a JSON object. See https://docs.nbold.co/api/latest/reference/Models/TeamProvisioningRequest for more information. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
ID
|
id | string |
The job ID, auto-generated at creation |
|
Logs
|
log | array of string |
A collection of JobLogsEntry. |
|
Type
|
type | string |
The job type (for instance |
|
Status
|
status | string |
The job current status |
|
Progress
|
progress | integer |
The job current progress |
|
data
|
data | object |
The job data (for instance a |
Generate a Signature for a Webhook (Preview)
Generate a signature from a secret and a webhook payload.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Secret
|
secret | True | password |
Webhook secret |
|
Payload
|
payload | True | object |
Webhook payload |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Signature
|
signature | string |
Calculated hook signature |
Get a Team (Preview)
Get detailed information about a team.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Team
|
teamId | True | string |
A team ID. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Team ID
|
id | string |
Unique identifier of the team |
|
Team creation date
|
createdDateTime | date-time |
Timestamp when the team was created |
|
Team name
|
displayName | string |
The name of the team |
|
Team description
|
description | string |
A brief description of the team |
|
Internal Team ID
|
internalId | string |
Internal identifier for the team |
|
Team classification
|
classification | string |
Classification of the team (if applicable) |
|
Team specialization
|
specialization | string |
Specialization type of the team |
|
Team visibility
|
visibility | string |
The visibility of the team |
|
Team web link
|
webUrl | uri |
The web URL to access the team |
|
Team archive status
|
isArchived | boolean |
Indicates whether the team is archived |
|
Membership limited to owners
|
isMembershipLimitedToOwners | boolean |
Indicates if membership is limited to owners |
|
Teams search
|
discoverySettings.showInTeamsSearchAndSuggestions | boolean |
Teams Search And Suggestions. |
|
Tag settings
|
tagSettings | object |
Settings related to tags |
Get My Teams Collaboration Templates (Preview)
Get the teams collaboration templates accessible to the connected user filtered by the audience targeting rules.
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Collection
|
value | array of object |
Array of catalog templates |
|
ID
|
value.templateConfiguration.id | string |
The collaboration template ID. |
|
Name
|
value.templateConfiguration.name | string |
The collaboration template name. |
|
Description
|
value.templateConfiguration.description | string |
The collaboration template description. |
|
Picture URL
|
value.templateConfiguration.pictureUrl | string |
The collaboration template picture URL. |
|
Language
|
value.templateConfiguration.language | string |
The collaboration template language. |
|
Enabled
|
value.templateConfiguration.enabled |
Defines if the collaboration template is enabled or not. |
|
|
Requires
|
value.templateConfiguration.approval.requireApproval |
Defines if the collaboration template requires an approval or not. |
|
|
Team Members
|
value.templateConfiguration.approval.approvalTeam | array of object |
Members of an approval team. |
|
ID
|
value.templateConfiguration.approval.approvalTeam.id | string |
User ID (From Active Directory) |
|
Name
|
value.templateConfiguration.approval.approvalTeam.name | string |
User Display Name (From Active Directory) |
|
Members
|
value.templateConfiguration.permanentMembership.members | array of object |
Members of a permanent membership team. |
|
ID
|
value.templateConfiguration.permanentMembership.members.id | string |
User ID (From Active Directory) |
|
Name
|
value.templateConfiguration.permanentMembership.members.name | string |
User Display Name (From Active Directory) |
|
Owners
|
value.templateConfiguration.permanentMembership.owners | array of object |
Members of a permanent membership team. |
|
ID
|
value.templateConfiguration.permanentMembership.owners.id | string |
User ID (From Active Directory) |
|
Name
|
value.templateConfiguration.permanentMembership.owners.name | string |
User Display Name (From Active Directory) |
|
Enabled
|
value.templateConfiguration.audienceTargeting.enabled |
the collaboration template specific audiences or not. |
|
|
Rules
|
value.templateConfiguration.audienceTargeting.rules | string |
Defines the audience targeting rules. |
|
ID
|
value.clonedTeam.teamId | string |
The collaboration template source team ID. |
|
Name
|
value.clonedTeam.teamName | string |
The collaboration template source team name. |
|
Apps
|
value.clonedTeam.includeApps |
Defines if apps should be cloned from the source team. |
|
|
Tabs
|
value.clonedTeam.includeTabs |
Defines if tabs should be cloned from the source team. |
|
|
Settings
|
value.clonedTeam.includeSettings |
Defines if the team settings should be cloned from the source team. |
|
|
Channels
|
value.clonedTeam.includeChannels |
Defines if channels should be cloned from the source team. |
|
|
Membership
|
value.clonedTeam.includeMembers |
Defines membership (members and owners). |
|
|
Naming Convention
|
value.newTeam.namingConvention | string |
Defines the naming convention for the new team name. |
|
Email Convention
|
value.newTeam.emailConvention | string |
Defines the naming convention for the email. |
|
Description Convention
|
value.newTeam.descriptionConvention | string |
Defines the Description convention for the new team. |
|
Welcome Message Convention
|
value.newTeam.welcomeMessageConvention | string |
Defines the welcome message convention for the new team. |
|
Default Team Name
|
value.newTeam.defaultName | string |
Defines the default team name. in the new team provisioning form. |
|
Default Team Description
|
value.newTeam.defaultDescription |
Defines the default team description. type: string |
|
|
Default Welcome Message
|
value.newTeam.defaultWelcomeMessage | string |
Defines the default team welcome message. |
|
Team Privacy
|
value.newTeam.teamPrivacy | string |
Defines the new team privacy level (public/private). |
|
Requester Ownership
|
value.newTeam.addRequesterAsTeamOwner |
Defines if the requester of the new team. |
Get the Channels of a Team (Preview)
Get all the channels of a team.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Team
|
teamId | True | string |
The team ID. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Team Channels
|
array of object |
Channels of a Microsoft Teams team. |
|
|
ID
|
id | string |
Team Channel ID |
|
Created Date Time
|
createdDateTime | string |
Team Channel Created Date Time |
|
Display Name
|
displayName | string |
Team Channel Display Name |
|
Description
|
description | string |
Team Channel Description |
|
Membership Type
|
membershipType | string |
Team Channel Membership Type |
Get the Primary Channel of a Team (Preview)
Get the primary channel of a team.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Team
|
teamId | True | string |
The team ID. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
ID
|
id | string |
Team Channel ID |
|
Created Date Time
|
createdDateTime | string |
Team Channel Created Date Time |
|
Display Name
|
displayName | string |
Team Channel Display Name |
|
Description
|
description | string |
Team Channel Description |
|
Membership Type
|
membershipType | string |
Team Channel Membership Type |
Invite a Member in a Team (Preview)
Invite a team member as a member or an owner.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Team
|
teamId | True | string |
The team ID. |
|
ID
|
id | True | string |
User ID |
|
Team Membership Role
|
role | True | string |
Team Membership Role (member/owner) |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
@odata.context
|
@odata.context | string |
OData context URL |
|
@odata.type
|
@odata.type | string |
OData type identifier |
|
ID
|
id | string |
Unique identifier |
|
Role
|
role | string |
User role |
|
displayName
|
displayName | string |
User display name |
|
History Start Date Time
|
visibleHistoryStartDateTime | date-time |
Start date-time for visible history |
|
User Id
|
userId | string |
User identifier |
|
Email
|
User email address |
||
|
Tenant ID
|
tenantId | string |
Tenant identifier |
Reject a Team Creation Request (Preview)
Reject a team creation request.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Approval Request
|
approvalRequestId | True | string |
The ID of the approval request you want to reject. |
|
ID
|
id | string |
Impersonate the approver by specifying a User ID. If empty, you'll be automatically assigned as the approver. |
|
|
Message
|
message | string |
Message to be sent to the requester. |
Returns
Response for approval request reject.
- Approval Request Reject Body
- object
Unarchive a Team (Preview)
Unarchive a team.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Team
|
teamId | True | string |
The team ID. |
Returns
Team Urchiving Body.
- Team Unarchive
- object
Triggers
| When a Team Creation Approval is Requested (Preview) |
When a team creation approval is requested. |
| When a Team Creation is Approved (Preview) |
When a team creation is approved. |
| When a Team Creation is Rejected (Preview) |
When a team creation is rejected. |
| When a Team is Created Using a Collaboration Template (Preview) |
When a team is created using a collaboration template. |
When a Team Creation Approval is Requested (Preview)
When a team creation approval is requested.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Webhook Name
|
name | True | string |
Name |
|
Webhook Description
|
description | True | string |
Webhook description |
|
Secret
|
secret | password |
A secret key that you can use to verify the webhook notification message |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
ID
|
tenant.id | string |
Current tenant ID |
|
ID
|
requester.id | string |
Requester ID |
|
Display name
|
requester.displayName | string |
Requester display name |
|
Email
|
requester.mail | string |
Requester email |
|
Request ID
|
approval.id | string |
Approval request ID |
|
ID
|
approval.approver.id | string |
Approver ID |
|
message
|
approval.approver.message | string |
Approver message |
|
ID
|
template.id | string |
Template ID |
|
Name
|
template.name | string |
Template name |
|
Approval
|
template.approvers | array of object |
Approval team |
|
Items
|
template.approvers | object |
Items Body |
|
Permanent members and owners
|
template.permanentMembership | object |
Permanent members and owners |
|
Name
|
request.team.name | string |
Requested team name |
|
Description
|
request.team.description | string |
Requested team description |
|
Welcome message
|
request.team.welcomeMessage | string |
Requested team welcome message |
|
Members and owners
|
request.membership | object |
Requested members and owners |
When a Team Creation is Approved (Preview)
When a team creation is approved.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Webhook Name
|
name | True | string |
Name |
|
Webhook Description
|
description | True | string |
Webhook description |
|
Secret
|
secret | password |
A secret key that you can use to verify the webhook notification message |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
ID
|
tenant.id | string |
Current tenant ID |
|
ID
|
requester.id | string |
Requester ID |
|
Display name
|
requester.displayName | string |
Requester display name |
|
Email
|
requester.mail | string |
Requester email |
|
Request ID
|
approval.id | string |
Approval request ID |
|
ID
|
approval.approver.id | string |
Approver ID |
|
Message
|
approval.approver.message | string |
Approver message |
|
ID
|
template.id | string |
Template ID |
|
Name
|
template.name | string |
Template name |
|
Approvers
|
template.approvers | array of object |
Approvers body. |
|
Items
|
template.approvers | object |
Items Body |
|
Permanent members and owners
|
template.permanentMembership | object |
Permanent members and owners |
|
Name
|
request.team.name | string |
Requested team name |
|
Description
|
request.team.description | string |
Requested team description |
|
Welcome message
|
request.team.welcomeMessage | string |
Requested team welcome message |
|
Members and owners
|
request.membership | object |
Requested members and owners |
|
Job ID
|
provisioning.id | string |
Provisioning Job ID |
When a Team Creation is Rejected (Preview)
When a team creation is rejected.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Webhook Name
|
name | True | string |
Name |
|
Webhook Description
|
description | True | string |
Webhook description |
|
Secret
|
secret | password |
A secret key that you can use to verify the webhook notification message |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
ID
|
tenant.id | string |
Current tenant ID |
|
ID
|
requester.id | string |
Requester ID |
|
Display name
|
requester.displayName | string |
Requester display name |
|
Email
|
requester.mail | string |
Requester email |
|
Request ID
|
approval.id | string |
Approval request ID |
|
ID
|
approval.approver.id | string |
Approver ID |
|
Message
|
approval.approver.message | string |
Approver message |
|
ID
|
template.id | string |
Template ID |
|
Name
|
template.name | string |
Template name |
|
Approvers
|
template.approvers | array of object |
Approvers body. |
|
Items
|
template.approvers | object |
Items Body |
|
Permanent members and owners
|
template.permanentMembership | object |
Permanent members and owners |
|
Name
|
request.team.name | string |
Requested team name |
|
Description
|
request.team.description | string |
Requested team description |
|
Welcome message
|
request.team.welcomeMessage | string |
Requested team welcome message |
|
Members and owners
|
request.membership | object |
Requested members and owners |
When a Team is Created Using a Collaboration Template (Preview)
When a team is created using a collaboration template.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Webhook Name
|
name | True | string |
Name |
|
Webhook Description
|
description | True | string |
Webhook description |
|
Secret
|
secret | password |
A secret key that you can use to verify the webhook notification message |
|
|
List
|
id | string |
Template name. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Correlation ID
|
correlation_id | string |
Unique identifier for tracking the request. |
|
Credential ID
|
credentials.id | string |
Unique identifier for the credentials. |
|
Credential Type
|
credentials.type | string |
Type of credentials (e.g., service_account). |
|
Service Account Object ID
|
credentials.service_account_object_id | string |
Object ID of the service account. |
|
Service Account Name
|
credentials.service_account_name | string |
Name of the service account. |
|
Service Account UPN
|
credentials.service_account_upn | string |
User Principal Name of the service account. |
|
Access Token
|
credentials.service_account_access_token | string |
Access token for the service account. |
|
Refresh Token
|
credentials.service_account_refresh_token | string |
Refresh token for the service account. |
|
Renewal Success
|
credentials.renewal_success | boolean |
Indicates if the token renewal was successful. |
|
Renewal Error Message
|
credentials.renewal_error_message | string |
Error message if token renewal failed. |
|
Granted Permissions
|
credentials.granted_permissions | string |
Permissions granted to the service account. |
|
Missing Permissions
|
credentials.missing_permissions | string |
Permissions missing for the service account. |
|
Reports Concealed Option
|
credentials.reports_concealed_option | boolean |
Indicates if reports are concealed. |
|
Created At
|
credentials.created_at | date-time |
Timestamp when the credentials were created. |
|
Updated At
|
credentials.updated_at | date-time |
Timestamp when the credentials were last updated. |
|
Organization ID
|
credentials.organization_id | string |
Identifier for the organization (if applicable). |
|
ID
|
tenant.id | string |
Unique identifier for the tenant. |
|
Tenant ID
|
tenant.tenant_id | string |
Tenant identifier. |
|
Team ID
|
team.id | string |
Unique identifier for the team. |
|
Display Name
|
team.displayName | string |
Name of the team. |
|
@odata.context
|
team.sharepoint.@odata.context | string |
OData context for the SharePoint site. |
|
Created DateTime
|
team.sharepoint.createdDateTime | date-time |
Creation date and time of the SharePoint site. |
|
Description
|
team.sharepoint.description | string |
Description of the SharePoint site. |
|
SharePoint ID
|
team.sharepoint.id | string |
Identifier of the SharePoint site. |
|
Last Modified DateTime
|
team.sharepoint.lastModifiedDateTime | date-time |
Last modification date and time of the SharePoint site. |
|
Name
|
team.sharepoint.name | string |
Name of the SharePoint site. |
|
Web URL
|
team.sharepoint.webUrl | string |
URL of the SharePoint site. |
|
Display Name
|
team.sharepoint.displayName | string |
Display name of the SharePoint site. |
|
Root
|
team.sharepoint.root | object |
Root object of the SharePoint site. |
|
Hostname
|
team.sharepoint.siteCollection.hostname | string |
Hostname of the site collection. |
|
Template ID
|
template.id | string |
Identifier for the template. |
|
Template Name
|
template.name | string |
Name of the template. |
|
Requester ID
|
requester.id | string |
Unique identifier for the requester. |
|
Display Name
|
requester.displayName | string |
Display name of the requester. |
|
Email
|
requester.mail | string |
Email address of the requester. |
|
Deal ID
|
metadata.deal_room_hs.deal_id | string |
Identifier for the HubSpot deal. |
|
Created At
|
metadata.deal.createdAt | date-time |
Deal creation timestamp. |
|
Archived
|
metadata.deal.archived | boolean |
Indicates if the deal is archived. |
|
Deal ID
|
metadata.deal.id | string |
Identifier for the deal. |
|
Amount
|
metadata.deal.properties.amount | string |
Deal amount. |
|
Close Date
|
metadata.deal.properties.closedate | date-time |
Expected close date of the deal. |
|
Create Date
|
metadata.deal.properties.createdate | date-time |
Creation date of the deal. |
|
Deal Name
|
metadata.deal.properties.dealname | string |
Name of the deal. |
|
Deal Stage
|
metadata.deal.properties.dealstage | string |
Current stage of the deal. |
|
Last Modified Date
|
metadata.deal.properties.hs_lastmodifieddate | date-time |
Timestamp of the last modification. |
|
HubSpot Object ID
|
metadata.deal.properties.hs_object_id | string |
HubSpot's unique identifier for the deal. |
|
HubSpot Owner ID
|
metadata.deal.properties.hubspot_owner_id | string |
Owner identifier in HubSpot. |
|
Pipeline
|
metadata.deal.properties.pipeline | string |
Sales pipeline identifier. |
|
Updated At
|
metadata.deal.updatedAt | date-time |
Timestamp when the deal was last updated. |
|
Status
|
status | string |
Status of the operation. |
Definitions
object
This is the type 'object'.