Broadcast

Create a new broadcast

POST

http://localhost:3000/api/broadcasts

curl -X POST 'http://localhost:3000/api/broadcasts' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "tenant": {},
  "tenantId": "string",
  "organization": {},
  "organizationId": "string",
  "sentTo": "string",
  "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",
  "entity": "Broadcast",
  "entityId": "string",
  "title": "string",
  "content": {},
  "category": "STATUS_REPORT",
  "visibilityMode": "ENTITY_MEMBERS",
  "audienceRules": {},
  "publishedAt": "2024-01-15T09:30:00Z"
}'

const body = `{
  "tenant": {},
  "tenantId": "string",
  "organization": {},
  "organizationId": "string",
  "sentTo": "string",
  "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",
  "entity": "Broadcast",
  "entityId": "string",
  "title": "string",
  "content": {},
  "category": "STATUS_REPORT",
  "visibilityMode": "ENTITY_MEMBERS",
  "audienceRules": {},
  "publishedAt": "2024-01-15T09:30:00Z"
}`;

const response = await fetch('http://localhost:3000/api/broadcasts', {
  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",
  "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",
  "entity": "Broadcast",
  "entityId": "string",
  "title": "string",
  "content": {},
  "category": "STATUS_REPORT",
  "visibilityMode": "ENTITY_MEMBERS",
  "audienceRules": {},
  "publishedAt": "2024-01-15T09:30:00Z"
}'''

response = requests.post(
    'http://localhost:3000/api/broadcasts',
    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",
  "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",
  "entity": "Broadcast",
  "entityId": "string",
  "title": "string",
  "content": {},
  "category": "STATUS_REPORT",
  "visibilityMode": "ENTITY_MEMBERS",
  "audienceRules": {},
  "publishedAt": "2024-01-15T09:30:00Z"
}

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",
  "title": "string",
  "content": {},
  "category": "STATUS_REPORT",
  "visibilityMode": "ENTITY_MEMBERS",
  "audienceRules": {},
  "publishedAt": "2024-01-15T09:30:00Z",
  "employeeId": "string"
}

Body

application/json

tenantobject

tenantIdstring

organizationobjectrequired

organizationIdstring

sentTostring

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

entitystringBroadcastCandidateCommentContactCurrencyDailyPlanDashboardDashboardWidgetDocumentEmployeeExpenseInvoiceIncomeLanguageOrganizationOrganizationContactOrganizationDepartmentOrganizationDocumentOrganizationProjectOrganizationTeamOrganizationProjectModuleOrganizationSprintOrganizationVendorResourceLinkScreeningTaskOrganizationStrategicInitiativeTaskTaskLinkedIssueTaskViewUserTenantrequired

entityIdstringrequired

titlestringrequired

contentobjectrequired

categorystringSTATUS_REPORTMILESTONEANNOUNCEMENTALERTDECISIONCHANGELOGrequired

visibilityModestringENTITY_MEMBERSORGANIZATIONRESTRICTEDEXTERNAL_VIEWrequired

audienceRulesobject

publishedAtstring<date-time>

Response

201CreatedBroadcast

Broadcast created successfully

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

titlestringrequired

contentobjectrequired

categorystringSTATUS_REPORTMILESTONEANNOUNCEMENTALERTDECISIONCHANGELOGrequired

visibilityModestringENTITY_MEMBERSORGANIZATIONRESTRICTEDEXTERNAL_VIEWrequired

audienceRulesobject

publishedAtstring<date-time>

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