Invite

Create email invites

POST

http://localhost:3000/api/invite/emails

curl -X POST 'http://localhost:3000/api/invite/emails' \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "tenant": {},
  "tenantId": "string",
  "organization": {},
  "organizationId": "string",
  "sentTo": "string",
  "emailIds": [
    "string"
  ],
  "teamIds": [
    "string"
  ],
  "inviteType": "USER",
  "startedWorkOn": "2024-01-15T09:30:00Z",
  "invitationExpirationPeriod": 1,
  "fullName": "string",
  "callbackUrl": "string",
  "roleId": "string",
  "role": {}
}'

const body = `{
  "tenant": {},
  "tenantId": "string",
  "organization": {},
  "organizationId": "string",
  "sentTo": "string",
  "emailIds": [
    "string"
  ],
  "teamIds": [
    "string"
  ],
  "inviteType": "USER",
  "startedWorkOn": "2024-01-15T09:30:00Z",
  "invitationExpirationPeriod": 1,
  "fullName": "string",
  "callbackUrl": "string",
  "roleId": "string",
  "role": {}
}`;

const response = await fetch('http://localhost:3000/api/invite/emails', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
  },
  body,
});

const data = await response.text();

import requests

body = '''{
  "tenant": {},
  "tenantId": "string",
  "organization": {},
  "organizationId": "string",
  "sentTo": "string",
  "emailIds": [
    "string"
  ],
  "teamIds": [
    "string"
  ],
  "inviteType": "USER",
  "startedWorkOn": "2024-01-15T09:30:00Z",
  "invitationExpirationPeriod": 1,
  "fullName": "string",
  "callbackUrl": "string",
  "roleId": "string",
  "role": {}
}'''

response = requests.post(
    'http://localhost:3000/api/invite/emails',
    data=body.encode('utf-8'),
    headers={
        'Content-Type': 'application/json',
    },
)
print(response.text)

Request Body

{
  "tenant": {},
  "tenantId": "string",
  "organization": {},
  "organizationId": "string",
  "sentTo": "string",
  "emailIds": [
    "string"
  ],
  "teamIds": [
    "string"
  ],
  "inviteType": "USER",
  "startedWorkOn": "2024-01-15T09:30:00Z",
  "invitationExpirationPeriod": 1,
  "fullName": "string",
  "callbackUrl": "string",
  "roleId": "string",
  "role": {}
}

201

{
  "deletedAt": "2018-11-21T06:20:32.232Z",
  "createdAt": "2018-11-21T06:20:32.232Z",
  "updatedAt": "2018-11-21T06:20:32.232Z",
  "id": "string",
  "isActive": true,
  "isArchived": false,
  "archivedAt": "2018-11-21T06:20:32.232Z",
  "tenantId": "string",
  "organizationId": "string",
  "token": "string",
  "email": "string",
  "fullName": "string",
  "status": "INVITED",
  "expireDate": "2024-01-15T09:30:00Z",
  "actionDate": "2024-01-15T09:30:00Z",
  "role": {
    "deletedAt": "2018-11-21T06:20:32.232Z",
    "createdAt": "2018-11-21T06:20:32.232Z",
    "updatedAt": "2018-11-21T06:20:32.232Z",
    "id": "string",
    "isActive": true,
    "isArchived": false,
    "archivedAt": "2018-11-21T06:20:32.232Z",
    "tenantId": "string",
    "name": "SUPER_ADMIN",
    "isSystem": false
  },
  "roleId": "string",
  "userId": "string"
}

Body

application/json

tenantobject

tenantIdstring

organizationobjectrequired

organizationIdstringrequired

sentTostring

emailIdsArray<string>required

teamIdsArray<string>

inviteTypestringUSEREMPLOYEECANDIDATETEAMrequired

startedWorkOnstring<date-time>

invitationExpirationPeriodstring171430Never

fullNamestring

callbackUrlstring

roleIdstringrequired

roleobjectrequired

Role reference: an object with the role id (UUID).

Response

201CreatedInvite

The record has been successfully created.

Response fields application/json

deletedAtstring<date-time>

Example

2018-11-21T06:20:32.232Z

createdAtstring<date-time>

The creation timestamp of the entity.

Example

2018-11-21T06:20:32.232Z

updatedAtstring<date-time>

The last update timestamp of the entity.

Example

2018-11-21T06:20:32.232Z

idstring

isActivebooleantrue

isArchivedbooleanfalse

archivedAtstring<date-time>

Example

2018-11-21T06:20:32.232Z

tenantIdstring

organizationIdstring

tokenstringrequired

emailstringrequired

fullNamestring

statusstringINVITEDACCEPTEDEXPIREDREJECTEDrequired

expireDatestring<date-time>

actionDatestring<date-time>

roleRole

Show child attributes

deletedAtstring<date-time>

Example

2018-11-21T06:20:32.232Z

createdAtstring<date-time>

The creation timestamp of the entity.

Example

2018-11-21T06:20:32.232Z

updatedAtstring<date-time>

The last update timestamp of the entity.

Example

2018-11-21T06:20:32.232Z

idstring

isActivebooleantrue

isArchivedbooleanfalse

archivedAtstring<date-time>

Example

2018-11-21T06:20:32.232Z

tenantIdstring

namestringSUPER_ADMINADMINDATA_ENTRYEMPLOYEECANDIDATEMANAGERVIEWERINTERVIEWERrequired

isSystembooleanfalse

roleIdstring

userIdstring

400Bad Request

Invalid input, The response body may contain clues as to what went wrong

Stack Overflow Website Demo