SharedEntity

Update a shared entity

PUT

http://localhost:3000/api/shared-entities/{id}

curl -X PUT 'http://localhost:3000/api/shared-entities/string' \
  -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",
  "shareRules": {},
  "sharedOptions": {}
}'

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",
  "shareRules": {},
  "sharedOptions": {}
}`;

const response = await fetch('http://localhost:3000/api/shared-entities/string', {
  method: 'PUT',
  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",
  "shareRules": {},
  "sharedOptions": {}
}'''

response = requests.put(
    'http://localhost:3000/api/shared-entities/string',
    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",
  "shareRules": {},
  "sharedOptions": {}
}

200

{
  "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",
  "token": "string",
  "shareRules": {},
  "sharedOptions": {}
}

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

shareRulesobjectrequired

sharedOptionsobject

Parameters

idstringrequiredpath

Response

200OKSharedEntity

Shared entity updated 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

entitystringBroadcastCandidateCommentContactCurrencyDailyPlanDashboardDashboardWidgetDocumentEmployeeExpenseInvoiceIncomeLanguageOrganizationOrganizationContactOrganizationDepartmentOrganizationDocumentOrganizationProjectOrganizationTeamOrganizationProjectModuleOrganizationSprintOrganizationVendorResourceLinkScreeningTaskOrganizationStrategicInitiativeTaskTaskLinkedIssueTaskViewUserTenantrequired

entityIdstringrequired

tokenstringrequired

shareRulesobjectrequired

sharedOptionsobject

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