Sign in

v1

latestOpenAPI 3.0.12026-07-24241275527.9 KB
Invitations

Create Invitation

Create an invitation into the current account.

<b>Scopes:</b> amReadWriteInvitation

post/invitations

Query parameters

emailstring required

Create an invitation for current email

Create an invitation for current email

firstNamestring

First name of invited user

First name of invited user

lastNamestring

Last name of invited user

Last name of invited user

role'User' | 'Collaborator'
  • User
  • Collaborator

[Deprecated] It is recommended to use 'userTypeId' parameter instead. Set user role in account. Mutually exclusive with userTypeId param

  • User
  • Collaborator
externalboolean

[Deprecated] It is recommended to use 'userTypeId' parameter instead. Set external flag for invited user. Flag 'External' can be applied only to the role 'User'. Mutually exclusive with userTypeId param

[Deprecated] It is recommended to use 'userTypeId' parameter instead. Set external flag for invited user. Flag 'External' can be applied only to the role 'User'. Mutually exclusive with userTypeId param

subjectstring

Custom message subject. Not available for free accounts

Custom message subject. Not available for free accounts

messagestring

Custom message body. Not available for free accounts

Custom message body. Not available for free accounts

userTypeIdstring

Set user type in account. Mutually exclusive with role and external params

Set user type in account. Mutually exclusive with role and external params

Response

success response

kind'accounts' | 'users' | 'contacts' | 'assets' | 'eDiscoveryReport' | 'folders' | 'folderTree' | 'tasks' | 'taskIds' | 'timelogs' | 'timelogCategories' | 'timelogLockPeriods' | 'timetrackerTimers' | 'comments' | 'attachments' | 'url' | 'version' | 'dataExport' | 'dataExportSchema' | 'auditLog' | 'accessRoles' | 'stream' | 'changes' | 'posts' | 'mailSettings' | 'integrationInfo' | 'gmailIntegrationSettings' | 'workTypesForIntegrations' | 'ids' | 'backups' | 'domains' | 'dependencies' | 'workflows' | 'workschedules' | 'workscheduleExclusions' | 'workscheduleUserExclusions' | 'customfields' | 'customfieldIds' | 'customstatuses' | 'invitations' | 'notifications' | 'jobroles' | 'placeholders' | 'groups' | 'session' | 'dashboards' | 'widgets' | 'taskCreationSettings' | 'colors' | 'experiments' | 'topics' | 'topicComments' | 'webhooks' | 'reviews' | 'boards' | 'textSearch' | 'chatChannels' | 'chatMessages' | 'forms' | 'requestForms' | 'request' | 'report' | 'platformWidgets' | 'platformWidgetInstances' | 'spaces' | 'pdf' | 'customerSatisfaction' | 'asyncJob' | 'approvals' | 'highlights' | 'highlightsList' | 'highlightsSettings' | 'highlightsCard' | 'timesheet' | 'timesheetRow' | 'timesheetSubmissionRule' | 'mobileFeatures' | 'mobileSettings' | 'folderBlueprintTree' | 'taskBlueprintTree' | 'feedback' | 'timeline_snapshot' | 'contactIds' | 'bookings' | 'integrateThreshold' | 'hourlyRatesProvision' | 'hourlyRates' | 'projectTeamMembers' | 'contactsHistory' | 'tasksHistory' | 'foldersHistory' | 'activityDigest' | 'workItemTemplates' | 'workTemplates' | 'workItemMetadata' | 'workItem' | 'customItemTypes' | 'verificationCode' | 'views' | 'listView' | 'tableView' | 'userTypes' | 'reactions' | 'externalRequesters' | 'workscheduleCapacityOverrides' | 'userCapacityOverrides' | 'userCapacityExclusions' | 'rollups' | 'requestFormPrefill' | 'userAggregatedCapacity' | 'cascadingFieldSettings'