EntitySubscriptions

Subscribe to an entity

POST

http://localhost:3000/api/entity-subscription

Creates a new subscription for an entity using the provided subscription details.

curl -X POST 'http://localhost:3000/api/entity-subscription' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "tenant": {},
  "tenantId": "string",
  "organization": {},
  "organizationId": "string",
  "sentTo": "string",
  "entity": "Broadcast",
  "entityId": "string",
  "actorType": "System",
  "type": "manual"
}'

const body = `{
  "tenant": {},
  "tenantId": "string",
  "organization": {},
  "organizationId": "string",
  "sentTo": "string",
  "entity": "Broadcast",
  "entityId": "string",
  "actorType": "System",
  "type": "manual"
}`;

const response = await fetch('http://localhost:3000/api/entity-subscription', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer YOUR_TOKEN',
    'Content-Type': 'application/json',
  },
  body,
});

const data = await response.text();

import requests

body = '''{
  "tenant": {},
  "tenantId": "string",
  "organization": {},
  "organizationId": "string",
  "sentTo": "string",
  "entity": "Broadcast",
  "entityId": "string",
  "actorType": "System",
  "type": "manual"
}'''

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

Request Body

{
  "tenant": {},
  "tenantId": "string",
  "organization": {},
  "organizationId": "string",
  "sentTo": "string",
  "entity": "Broadcast",
  "entityId": "string",
  "actorType": "System",
  "type": "manual"
}

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",
  "entity": "Broadcast",
  "entityId": "string",
  "actorType": "System",
  "type": "manual",
  "employee": {
    "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",
    "short_description": "string",
    "description": "string",
    "startedWorkOn": "2024-01-15T09:30:00Z",
    "endWork": "2024-01-15T09:30:00Z",
    "payPeriod": "WEEKLY",
    "billRateValue": 0,
    "minimumBillingRate": 0,
    "billRateCurrency": "USD",
    "reWeeklyLimit": 0,
    "offerDate": "2024-01-15T09:30:00Z",
    "acceptDate": "2024-01-15T09:30:00Z",
    "rejectDate": "2024-01-15T09:30:00Z",
    "employeeLevel": "string",
    "anonymousBonus": true,
    "averageIncome": 0,
    "averageBonus": 0,
    "totalWorkHours": 0,
    "averageExpenses": 0,
    "show_anonymous_bonus": true,
    "show_average_bonus": true,
    "show_average_expenses": true,
    "show_average_income": true,
    "show_billrate": true,
    "show_payperiod": true,
    "show_start_work_on": true,
    "isJobSearchActive": true,
    "linkedInUrl": "string",
    "facebookUrl": "string",
    "instagramUrl": "string",
    "twitterUrl": "string",
    "githubUrl": "string",
    "gitlabUrl": "string",
    "upworkUrl": "string",
    "stackoverflowUrl": "string",
    "isVerified": true,
    "isVetted": true,
    "totalJobs": 0,
    "jobSuccess": 0,
    "profile_link": "string",
    "isTrackingEnabled": true,
    "isOnline": true,
    "isAway": false,
    "isTrackingTime": true,
    "allowScreenshotCapture": true,
    "allowManualTime": true,
    "allowModifyTime": true,
    "allowDeleteTime": true,
    "allowAgentAppExit": true,
    "allowLogoutFromAgentApp": true,
    "trackKeyboardMouseActivity": true,
    "trackAllDisplays": true,
    "upworkId": "string",
    "linkedInId": "string",
    "userId": "string",
    "contactId": "string",
    "organizationPositionId": "string"
  },
  "employeeId": "string"
}

Body

application/json

The subscription details for creating a new entity subscription.

tenantobject

tenantIdstring

organizationobjectrequired

organizationIdstringrequired

sentTostring

entitystringBroadcastCandidateCommentContactCurrencyDailyPlanDashboardDashboardWidgetDocumentEmployeeExpenseInvoiceIncomeLanguageOrganizationOrganizationContactOrganizationDepartmentOrganizationDocumentOrganizationProjectOrganizationTeamOrganizationProjectModuleOrganizationSprintOrganizationVendorResourceLinkScreeningTaskOrganizationStrategicInitiativeTaskTaskLinkedIssueTaskViewUserTenantrequired

entityIdstringrequired

actorTypestringSystemUser

typestringmanualmentionassignmentcommentcreated-entityrequired

Response

201CreatedEntitySubscription

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

entityIdstringrequired

actorTypestringSystemUser

typestringmanualmentionassignmentcommentcreated-entityrequired

employeeEmployee

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

organizationIdstring

short_descriptionstring

descriptionstring

startedWorkOnstring<date-time>

endWorkstring<date-time>

payPeriodstringNONEBI_WEEKLYWEEKLYTWICE_PER_MONTHMONTHLY

Example

WEEKLY

billRateValuenumber

minimumBillingRatenumber

billRateCurrencystringAFNAFAALLALKDZDADPAOAAOKAONAORARAARSARMARPARLAMDAWGAUDATSAZNAZMBSDBHDBDTBBDBYNBYBBYRBEFBECBELBZDBMDBTNBOBBOLBOVBOPBAMBADBANBWPBRCBRZBREBRRBRNBRBBRLGBPBNDBGLBGNBGOBGMBUKBIFXPFKHRCADCVEKYDXAFCLECLPCLFCNXCNYCOPCOUKMFCDFCRCHRDHRKCUCCUPCYPCZKCSKDKKDJFDOPNLGXCDDDMECSECVEGPGQEERNEEKETBEURXEUFKPFJDFIMFRFXFOXFUGMDGEKGELDEMGHSGHCGIPGRDGTQGWPGNFGNSGYDHTGHNLHKDHUFISKISJINRIDRIRRIQDIEPILSILPILRITLJMDJPYJODKZTKESKWDKGSLAKLVLLVRLBPLSLLRDLYDLTLLTTLULLUCLUFMOPMKDMKNMGAMGFMWKMYRMVRMVPMLFMTLMTPMROMURMXVMXNMXPMDCMDLMCFMNTMADMAFMZEMZNMZMMMKNADNPRANGTWDNZDNIONICNGNKPWNOKOMRPKRPABPGKPYGPEIPENPESPHPPLNPLZPTEGWEQARXRERHDRONROLRUBRURRWFSVCWSTSARRSDCSDSCRSLLSGDSKKSITSBDSOSZARZALKRHKRWKROSSPSURESPESAESBLKRSHPSDDSDGSDPSRDSRGSZLSEKCHFSYPSTDTJRTJSTZSTHBTPETOPTTDTNDTRYTRLTMTTMMUSDUSNUSSUGXUGSUAHUAKAEDUYUUYPUYIUZSVUVVEFVEBVNDVNNCHECHWXOFYDDYERYUNYUDYUMYURZRNZRZZMWZMKZWDZWRZWL

Example

USD

reWeeklyLimitnumber

offerDatestring<date-time>

acceptDatestring<date-time>

rejectDatestring<date-time>

employeeLevelstring

anonymousBonusboolean

averageIncomenumberrequired

averageBonusnumberrequired

totalWorkHoursnumberrequired

averageExpensesnumberrequired

show_anonymous_bonusboolean

show_average_bonusboolean

show_average_expensesboolean

show_average_incomeboolean

show_billrateboolean

show_payperiodboolean

show_start_work_onboolean

isJobSearchActiveboolean

linkedInUrlstring

facebookUrlstring

instagramUrlstring

twitterUrlstring

githubUrlstring

gitlabUrlstring

upworkUrlstring

stackoverflowUrlstring

isVerifiedboolean

isVettedboolean

totalJobsnumberrequired

jobSuccessnumberrequired

profile_linkstring

isTrackingEnabledboolean

isOnlineboolean

isAwaystringfalse

isTrackingTimeboolean

allowScreenshotCaptureboolean

allowManualTimeboolean

allowModifyTimeboolean

allowDeleteTimeboolean

allowAgentAppExitboolean

allowLogoutFromAgentAppboolean

trackKeyboardMouseActivityboolean

trackAllDisplaysboolean

upworkIdstring

linkedInIdstring

userIdstringrequired

contactIdstringrequired

organizationPositionIdstringrequired

employeeIdstring

400Bad Request

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

401Unauthorized

Unauthorized

403Forbidden

Forbidden

Authorization

bearerhttp (bearer) in header

Enter JWT token

Stack Overflow Website Demo