Create Announcement

post/createannouncement

Create a textual announcement visible to some set of users based on department and location.

SecurityBearerAuth

Request

header Parameters

X-Glean-ActAs	string <email> Email address of a user on whose behalf the request is intended to be made (should be non-empty only for global tokens).
X-Glean-Auth-Type	string Auth type being used to access the endpoint (should be non-empty only for global tokens).

Request Body schema: application/json
required

Announcement content

endTime required	string <date-time> The date and time at which the announcement expires.
startTime required	string <date-time> The date and time at which the announcement becomes active.
title required	string The headline of the announcement.
	Array of objects (FacetFilter) Filters which restrict who should see the announcement. Values are taken from the corresponding filters in people search.
	object (Thumbnail)
	object (StructuredText)
channel	string This determines whether this is a Social Feed post or a regular announcement. Enum: "MAIN" "SOCIAL_FEED"
emoji	string An emoji used to indicate the nature of the announcement.
hideAttribution	boolean Whether or not to hide an author attribution.
isPrioritized	boolean Used by the Social Feed to pin posts to the front of the feed.
postType	string This determines whether this is an external-link post or a regular announcement post. TEXT - Regular announcement that can contain rich text. LINK - Announcement that is linked to an external site. Enum: "TEXT" "LINK"
sourceDocumentId	string The Glean Document ID of the source document this Announcement was created from (e.g. Slack thread).
	object (Thumbnail)
viewUrl	string URL for viewing the announcement. It will be set to document URL for announcements from other datasources e.g. simpplr. Can only be written when channel="SOCIAL_FEED".

Responses

200

Response Schema: application/json

	Array of objects (FacetFilter) Filters which restrict who should see the announcement. Values are taken from the corresponding filters in people search.
	object (Person)
	object (Thumbnail)
	object (StructuredText)
channel	string This determines whether this is a Social Feed post or a regular announcement. Enum: "MAIN" "SOCIAL_FEED"
createTimestamp	integer Server Unix timestamp of the creation time (in seconds since epoch UTC).
draftId	integer The opaque id of the associated draft.
emoji	string An emoji used to indicate the nature of the announcement.
endTime	string <date-time> The date and time at which the announcement expires.
hideAttribution	boolean Whether or not to hide an author attribution.
id	integer The opaque id of the announcement.
isPrioritized	boolean Used by the Social Feed to pin posts to the front of the feed.
isPublished	boolean Whether or not the announcement is published.
lastUpdateTimestamp	integer Server Unix timestamp of the last update time (in seconds since epoch UTC).
	object (ObjectPermissions)
postType	string This determines whether this is an external-link post or a regular announcement post. TEXT - Regular announcement that can contain rich text. LINK - Announcement that is linked to an external site. Enum: "TEXT" "LINK"
	object (Document)
sourceDocumentId	string The Glean Document ID of the source document this Announcement was created from (e.g. Slack thread).
startTime	string <date-time> The date and time at which the announcement becomes active.
	object (Thumbnail)
title	string The headline of the announcement.
	object (Person)
	object
viewUrl	string URL for viewing the announcement. It will be set to document URL for announcements from other datasources e.g. simpplr. Can only be written when channel="SOCIAL_FEED".

400

Invalid request

401

Not Authorized

429

Too Many Requests

Request samples

Payload
curl

application/json

{"startTime": "2019-08-24T14:15:22Z",
"endTime": "2019-08-24T14:15:22Z",
"title": "string",
"body": {"text": "From https://en.wikipedia.org/wiki/Diffuse_sky_radiation, the sky is blue because blue light is more strongly scattered than longer-wavelength light.",
"structuredList": [{"link": "https://en.wikipedia.org/wiki/Diffuse_sky_radiation",
"document": {"id": "string",
"datasource": "string",
"connectorType": "API_CRAWL",
"docType": "string",
"content": {"fullTextList": ["string"
]
},
"containerDocument": { },
"parentDocument": { },
"title": "string",
"url": "string",
"metadata": {"container": "container",
"parentId": "JIRA_EN-1337",
"createTime": "2000-01-23T04:56:07.000Z",
"datasource": "datasource",
"author": {"name": "name"
},
"documentId": "documentId",
"updateTime": "2000-01-23T04:56:07.000Z",
"mimeType": "mimeType",
"objectType": "Feature Request",
"components": ["Backend",
"Networking"
],
"status": ["Done"
],
"customData": {"someCustomField": "someCustomValue"
}
},
"sections": [{"title": "string",
"url": "string"
}
]
},
"text": "Because its wavelengths are shorter, blue light is more strongly scattered than the longer-wavelength lights, red or green. Hence the result that when looking at the sky away from the direct incident sunlight, the human eye perceives the sky to be blue.",
"structuredResult": {"document": {"id": "string",
"datasource": "string",
"connectorType": "API_CRAWL",
"docType": "string",
"content": {"fullTextList": [null
]
},
"containerDocument": { },
"parentDocument": { },
"title": "string",
"url": "string",
"metadata": {"container": "container",
"parentId": "JIRA_EN-1337",
"createTime": "2000-01-23T04:56:07.000Z",
"datasource": "datasource",
"author": {"name": "name"
},
"documentId": "documentId",
"updateTime": "2000-01-23T04:56:07.000Z",
"mimeType": "mimeType",
"objectType": "Feature Request",
"components": ["Backend",
"Networking"
],
"status": ["Done"
],
"customData": {"someCustomField": "someCustomValue"
}
},
"sections": [{"title": null,
"url": null
}
]
},
"person": {"name": "George Clooney",
"obfuscatedId": "abc123"
},
"customer": {"id": "string",
"domains": ["string"
],
"company": {"name": "string",
"profileUrl": "string",
"websiteUrls": [null
],
"logoUrl": "string",
"location": "New York City",
"phone": "string",
"fax": "string",
"industry": "Finances",
"annualRevenue": 0,
"numberOfEmployees": 0,
"stockSymbol": "string",
"foundedDate": "2019-08-24",
"about": "Financial, software, data, and media company headquartered in Midtown Manhattan, New York City"
},
"documentCounts": {"property1": 0,
"property2": 0
},
"poc": [{"name": "George Clooney",
"obfuscatedId": "abc123"
}
],
"metadata": {"datasourceId": "string",
"customData": {"property1": null,
"property2": null
}
},
"mergedCustomers": [{ }
],
"startDate": "2019-08-24",
"contractAnnualRevenue": 0,
"notes": "CIO is interested in trying out the product."
},
"team": {"relatedObjects": {"property1": {"objects": [ ]
},
"property2": {"objects": [ ]
}
},
"permissions": {"write": {"scopeType": null,
"create": null,
"update": null,
"delete": null
}
},
"id": "string",
"name": "string",
"description": "string",
"businessUnit": "string",
"department": "string",
"photoUrl": "string",
"bannerUrl": "string",
"externalLink": "http://example.com",
"members": [{"person": null,
"relationship": null,
"customRelationshipStr": null,
"joinDate": null
}
],
"memberCount": 0,
"emails": [{"email": null,
"type": null,
"isUserGenerated": null
}
],
"customFields": [{"label": null,
"values": [ ],
"displayable": null
}
],
"datasourceProfiles": [{"datasource": null,
"handle": null,
"url": null,
"nativeAppUrl": null,
"isUserGenerated": null
}
],
"datasource": "string",
"createdFrom": "string",
"lastUpdatedAt": "2019-08-24T14:15:22Z",
"status": "PROCESSED",
"canBeDeleted": true,
"loggingId": "string"
},
"customEntity": {"permissions": {"write": {"scopeType": null,
"create": null,
"update": null,
"delete": null
}
},
"id": "string",
"title": "string",
"datasource": "string",
"objectType": "string",
"metadata": {"customData": {"property1": null,
"property2": null
}
},
"roles": [{"sourceDocumentSpec": null,
"person": null,
"group": null,
"role": null
}
]
},
"answer": {"id": 3,
"docId": "ANSWERS_answer_3",
"question": "Why is the sky blue?",
"questionVariations": ["string"
],
"bodyText": "From https://en.wikipedia.org/wiki/Diffuse_sky_radiation, the sky is blue because blue light is more strongly scattered than longer-wavelength light.",
"boardId": 0,
"audienceFilters": [{"fieldName": "type",
"values": [{"value": "Spreadsheet",
"relationType": "EQUALS"
},
{"value": "Presentation",
"relationType": "EQUALS"
}
]
}
],
"addedRoles": [{"sourceDocumentSpec": null,
"person": null,
"group": null,
"role": null
}
],
"removedRoles": [{"sourceDocumentSpec": null,
"person": null,
"group": null,
"role": null
}
],
"roles": [{"sourceDocumentSpec": null,
"person": null,
"group": null,
"role": null
}
],
"sourceDocumentSpec": {"url": "string"
},
"sourceType": "DOCUMENT",
"permissions": {"write": {"scopeType": null,
"create": null,
"update": null,
"delete": null
}
},
"combinedAnswerText": null,
"likes": {"likedBy": [null
],
"likedByUser": true,
"numLikes": 0
},
"author": {"name": "George Clooney",
"obfuscatedId": "abc123"
},
"createTime": "2019-08-24T14:15:22Z",
"updateTime": "2019-08-24T14:15:22Z",
"updatedBy": {"name": "George Clooney",
"obfuscatedId": "abc123"
},
"verification": {"state": "UNVERIFIED",
"metadata": {"lastVerifier": null,
"lastVerificationTs": null,
"expirationTs": null,
"document": null,
"reminders": [ ],
"lastReminder": null,
"visitorCount": [ ],
"candidateVerifiers": [ ]
}
},
"board": {"name": "string",
"description": "string",
"addedRoles": [null
],
"removedRoles": [null
],
"audienceFilters": [null
],
"permissions": {"write": null
},
"id": 0,
"createTime": "2019-08-24T14:15:22Z",
"updateTime": "2019-08-24T14:15:22Z",
"creator": {"name": "George Clooney",
"obfuscatedId": "abc123"
},
"updatedBy": {"name": "George Clooney",
"obfuscatedId": "abc123"
},
"itemCount": 0,
"roles": [null
]
},
"collections": [{"name": null,
"description": null,
"addedRoles": [ ],
"removedRoles": [ ],
"audienceFilters": [ ],
"icon": null,
"adminLocked": null,
"parentId": null,
"thumbnail": null,
"allowedDatasource": null,
"permissions": null,
"id": null,
"createTime": null,
"updateTime": null,
"creator": null,
"updatedBy": null,
"itemCount": null,
"childCount": null,
"items": [ ],
"pinMetadata": null,
"shortcuts": [ ],
"children": [ ],
"roles": [ ]
}
],
"documentCategory": "string",
"sourceDocument": {"id": "string",
"datasource": "string",
"connectorType": "API_CRAWL",
"docType": "string",
"content": {"fullTextList": [ ]
},
"containerDocument": { },
"parentDocument": { },
"title": "string",
"url": "string",
"metadata": {"container": "container",
"parentId": "JIRA_EN-1337",
"createTime": "2000-01-23T04:56:07.000Z",
"datasource": "datasource",
"author": {"name": "name"
},
"documentId": "documentId",
"updateTime": "2000-01-23T04:56:07.000Z",
"mimeType": "mimeType",
"objectType": "Feature Request",
"components": ["Backend",
"Networking"
],
"status": ["Done"
],
"customData": {"someCustomField": "someCustomValue"
}
},
"sections": [null
]
}
},
"extractedQnA": {"heading": "string",
"question": "string",
"questionResult": {"snippets": [{"snippet": "snippet",
"mimeType": "mimeType"
}
],
"metadata": {"container": "container",
"createTime": "2000-01-23T04:56:07.000Z",
"datasource": "datasource",
"author": {"name": "name"
},
"documentId": "documentId",
"updateTime": "2000-01-23T04:56:07.000Z",
"mimeType": "mimeType",
"objectType": "objectType"
},
"title": "title",
"url": "https://example.com/foo/bar",
"nativeAppUrl": "slack://foo/bar",
"mustIncludeSuggestions": [{"missingTerm": "container",
"query": "container"
}
]
}
},
"meeting": {"id": "string",
"title": "string",
"description": "string",
"url": "string",
"startTime": "2019-08-24T14:15:22Z",
"endTime": "2019-08-24T14:15:22Z",
"attendees": {"people": [null
],
"isLimit": true,
"total": 0,
"numAccepted": 0,
"numDeclined": 0,
"numNoResponse": 0,
"numTentative": 0
}
},
"app": {"datasource": "string",
"docType": "string",
"mimeType": "string",
"iconUrl": "string"
},
"collection": {"name": "string",
"description": "string",
"addedRoles": [{"sourceDocumentSpec": null,
"person": null,
"group": null,
"role": null
}
],
"removedRoles": [{"sourceDocumentSpec": null,
"person": null,
"group": null,
"role": null
}
],
"audienceFilters": [{"fieldName": "type",
"values": [{"value": "Spreadsheet",
"relationType": "EQUALS"
},
{"value": "Presentation",
"relationType": "EQUALS"
}
]
}
],
"icon": "string",
"adminLocked": true,
"parentId": 0,
"thumbnail": {"photoId": "string",
"url": "string"
},
"allowedDatasource": "string",
"permissions": {"write": {"scopeType": null,
"create": null,
"update": null,
"delete": null
}
},
"id": 0,
"createTime": "2019-08-24T14:15:22Z",
"updateTime": "2019-08-24T14:15:22Z",
"creator": {"name": "George Clooney",
"obfuscatedId": "abc123"
},
"updatedBy": {"name": "George Clooney",
"obfuscatedId": "abc123"
},
"itemCount": 0,
"childCount": 0,
"items": [{"name": null,
"description": null,
"icon": null,
"collectionId": null,
"documentId": null,
"url": null,
"itemId": null,
"createdBy": null,
"createdAt": null,
"document": null,
"shortcut": null,
"collection": null,
"itemType": null
}
],
"pinMetadata": {"existingPins": [null
],
"eligiblePins": [null
]
},
"shortcuts": ["string"
],
"children": [null
],
"roles": [{"sourceDocumentSpec": null,
"person": null,
"group": null,
"role": null
}
]
},
"answerBoard": {"name": "string",
"description": "string",
"addedRoles": [{"sourceDocumentSpec": null,
"person": null,
"group": null,
"role": null
}
],
"removedRoles": [{"sourceDocumentSpec": null,
"person": null,
"group": null,
"role": null
}
],
"audienceFilters": [{"fieldName": "type",
"values": [{"value": "Spreadsheet",
"relationType": "EQUALS"
},
{"value": "Presentation",
"relationType": "EQUALS"
}
]
}
],
"permissions": {"write": {"scopeType": null,
"create": null,
"update": null,
"delete": null
}
},
"id": 0,
"createTime": "2019-08-24T14:15:22Z",
"updateTime": "2019-08-24T14:15:22Z",
"creator": {"name": "George Clooney",
"obfuscatedId": "abc123"
},
"updatedBy": {"name": "George Clooney",
"obfuscatedId": "abc123"
},
"itemCount": 0,
"roles": [{"sourceDocumentSpec": null,
"person": null,
"group": null,
"role": null
}
]
},
"code": {"repoName": "scio",
"fileName": "README.md",
"matches": [{"lineNumber": 1,
"content": "Welcome to the beginning",
"ranges": [ ]
},
{"lineNumber": 2,
"content": "Second line of the file",
"ranges": [ ]
},
{"lineNumber": 3,
"content": "hello world hello world",
"ranges": [{"startindex": 0,
"endIndex": 5
},
{"startIndex": 12,
"endIndex": 17
}
]
}
]
},
"shortcut": {"id": 0,
"inputAlias": "string",
"destinationUrl": "string",
"destinationDocumentId": "string",
"description": "string",
"unlisted": true,
"urlTemplate": "string",
"addedRoles": [{"sourceDocumentSpec": null,
"person": null,
"group": null,
"role": null
}
],
"removedRoles": [{"sourceDocumentSpec": null,
"person": null,
"group": null,
"role": null
}
],
"permissions": {"write": {"scopeType": null,
"create": null,
"update": null,
"delete": null
}
},
"createdBy": {"name": "George Clooney",
"obfuscatedId": "abc123"
},
"createTime": "2019-08-24T14:15:22Z",
"updatedBy": {"name": "George Clooney",
"obfuscatedId": "abc123"
},
"updateTime": "2019-08-24T14:15:22Z",
"destinationDocument": {"id": "string",
"datasource": "string",
"connectorType": "API_CRAWL",
"docType": "string",
"content": {"fullTextList": [ ]
},
"containerDocument": { },
"parentDocument": { },
"title": "string",
"url": "string",
"metadata": {"container": "container",
"parentId": "JIRA_EN-1337",
"createTime": "2000-01-23T04:56:07.000Z",
"datasource": "datasource",
"author": {"name": "name"
},
"documentId": "documentId",
"updateTime": "2000-01-23T04:56:07.000Z",
"mimeType": "mimeType",
"objectType": "Feature Request",
"components": ["Backend",
"Networking"
],
"status": ["Done"
],
"customData": {"someCustomField": "someCustomValue"
}
},
"sections": [null
]
},
"intermediateUrl": "string",
"viewPrefix": "string",
"isExternal": true,
"editUrl": "string",
"alias": "string",
"title": "string",
"roles": [{"sourceDocumentSpec": null,
"person": null,
"group": null,
"role": null
}
]
},
"querySuggestions": {"suggestions": [{"query": "app:github type:pull author:mortimer",
"label": "Mortimer's PRs",
"datasource": "github"
}
],
"person": {"name": "George Clooney",
"obfuscatedId": "abc123"
}
},
"relatedDocuments": [{"relation": "ATTACHMENT",
"associatedEntityId": "string",
"querySuggestion": {"query": "app:github type:pull author:mortimer",
"label": "Mortimer's PRs",
"datasource": "github"
},
"documents": [null
],
"results": [null
]
}
],
"relatedQuestion": {"question": "string",
"answer": "string",
"ranges": [{"startIndex": null,
"endIndex": null,
"type": null,
"url": null,
"document": null
}
]
},
"disambiguation": {"name": "string",
"id": "string",
"type": "PERSON"
},
"snippets": [{"snippet": "snippet",
"mimeType": "mimeType"
}
],
"trackingToken": "string",
"prominence": "HERO",
"source": "EXPERT_DETECTION"
}
}
]
},
"emoji": "string",
"thumbnail": {"photoId": "string",
"url": "string"
},
"banner": {"photoId": "string",
"url": "string"
},
"audienceFilters": [{"fieldName": "type",
"values": [{"value": "Spreadsheet",
"relationType": "EQUALS"
},
{"value": "Presentation",
"relationType": "EQUALS"
}
]
}
],
"sourceDocumentId": "string",
"hideAttribution": true,
"channel": "MAIN",
"postType": "TEXT",
"isPrioritized": true,
"viewUrl": "string"
}

Response samples

application/json

{"startTime": "2019-08-24T14:15:22Z",
"endTime": "2019-08-24T14:15:22Z",
"title": "string",
"body": {"text": "From https://en.wikipedia.org/wiki/Diffuse_sky_radiation, the sky is blue because blue light is more strongly scattered than longer-wavelength light.",
"structuredList": [{"link": "https://en.wikipedia.org/wiki/Diffuse_sky_radiation",
"document": {"id": "string",
"datasource": "string",
"connectorType": "API_CRAWL",
"docType": "string",
"content": {"fullTextList": ["string"
]
},
"containerDocument": { },
"parentDocument": { },
"title": "string",
"url": "string",
"metadata": {"container": "container",
"parentId": "JIRA_EN-1337",
"createTime": "2000-01-23T04:56:07.000Z",
"datasource": "datasource",
"author": {"name": "name"
},
"documentId": "documentId",
"updateTime": "2000-01-23T04:56:07.000Z",
"mimeType": "mimeType",
"objectType": "Feature Request",
"components": ["Backend",
"Networking"
],
"status": ["Done"
],
"customData": {"someCustomField": "someCustomValue"
}
},
"sections": [{"title": "string",
"url": "string"
}
]
},
"text": "Because its wavelengths are shorter, blue light is more strongly scattered than the longer-wavelength lights, red or green. Hence the result that when looking at the sky away from the direct incident sunlight, the human eye perceives the sky to be blue.",
"structuredResult": {"document": {"id": "string",
"datasource": "string",
"connectorType": "API_CRAWL",
"docType": "string",
"content": {"fullTextList": [null
]
},
"containerDocument": { },
"parentDocument": { },
"title": "string",
"url": "string",
"metadata": {"container": "container",
"parentId": "JIRA_EN-1337",
"createTime": "2000-01-23T04:56:07.000Z",
"datasource": "datasource",
"author": {"name": "name"
},
"documentId": "documentId",
"updateTime": "2000-01-23T04:56:07.000Z",
"mimeType": "mimeType",
"objectType": "Feature Request",
"components": ["Backend",
"Networking"
],
"status": ["Done"
],
"customData": {"someCustomField": "someCustomValue"
}
},
"sections": [{"title": null,
"url": null
}
]
},
"person": {"name": "George Clooney",
"obfuscatedId": "abc123"
},
"customer": {"id": "string",
"domains": ["string"
],
"company": {"name": "string",
"profileUrl": "string",
"websiteUrls": [null
],
"logoUrl": "string",
"location": "New York City",
"phone": "string",
"fax": "string",
"industry": "Finances",
"annualRevenue": 0,
"numberOfEmployees": 0,
"stockSymbol": "string",
"foundedDate": "2019-08-24",
"about": "Financial, software, data, and media company headquartered in Midtown Manhattan, New York City"
},
"documentCounts": {"property1": 0,
"property2": 0
},
"poc": [{"name": "George Clooney",
"obfuscatedId": "abc123"
}
],
"metadata": {"datasourceId": "string",
"customData": {"property1": null,
"property2": null
}
},
"mergedCustomers": [{ }
],
"startDate": "2019-08-24",
"contractAnnualRevenue": 0,
"notes": "CIO is interested in trying out the product."
},
"team": {"relatedObjects": {"property1": {"objects": [ ]
},
"property2": {"objects": [ ]
}
},
"permissions": {"write": {"scopeType": null,
"create": null,
"update": null,
"delete": null
}
},
"id": "string",
"name": "string",
"description": "string",
"businessUnit": "string",
"department": "string",
"photoUrl": "string",
"bannerUrl": "string",
"externalLink": "http://example.com",
"members": [{"person": null,
"relationship": null,
"customRelationshipStr": null,
"joinDate": null
}
],
"memberCount": 0,
"emails": [{"email": null,
"type": null,
"isUserGenerated": null
}
],
"customFields": [{"label": null,
"values": [ ],
"displayable": null
}
],
"datasourceProfiles": [{"datasource": null,
"handle": null,
"url": null,
"nativeAppUrl": null,
"isUserGenerated": null
}
],
"datasource": "string",
"createdFrom": "string",
"lastUpdatedAt": "2019-08-24T14:15:22Z",
"status": "PROCESSED",
"canBeDeleted": true,
"loggingId": "string"
},
"customEntity": {"permissions": {"write": {"scopeType": null,
"create": null,
"update": null,
"delete": null
}
},
"id": "string",
"title": "string",
"datasource": "string",
"objectType": "string",
"metadata": {"customData": {"property1": null,
"property2": null
}
},
"roles": [{"sourceDocumentSpec": null,
"person": null,
"group": null,
"role": null
}
]
},
"answer": {"id": 3,
"docId": "ANSWERS_answer_3",
"question": "Why is the sky blue?",
"questionVariations": ["string"
],
"bodyText": "From https://en.wikipedia.org/wiki/Diffuse_sky_radiation, the sky is blue because blue light is more strongly scattered than longer-wavelength light.",
"boardId": 0,
"audienceFilters": [{"fieldName": "type",
"values": [{"value": "Spreadsheet",
"relationType": "EQUALS"
},
{"value": "Presentation",
"relationType": "EQUALS"
}
]
}
],
"addedRoles": [{"sourceDocumentSpec": null,
"person": null,
"group": null,
"role": null
}
],
"removedRoles": [{"sourceDocumentSpec": null,
"person": null,
"group": null,
"role": null
}
],
"roles": [{"sourceDocumentSpec": null,
"person": null,
"group": null,
"role": null
}
],
"sourceDocumentSpec": {"url": "string"
},
"sourceType": "DOCUMENT",
"permissions": {"write": {"scopeType": null,
"create": null,
"update": null,
"delete": null
}
},
"combinedAnswerText": null,
"likes": {"likedBy": [null
],
"likedByUser": true,
"numLikes": 0
},
"author": {"name": "George Clooney",
"obfuscatedId": "abc123"
},
"createTime": "2019-08-24T14:15:22Z",
"updateTime": "2019-08-24T14:15:22Z",
"updatedBy": {"name": "George Clooney",
"obfuscatedId": "abc123"
},
"verification": {"state": "UNVERIFIED",
"metadata": {"lastVerifier": null,
"lastVerificationTs": null,
"expirationTs": null,
"document": null,
"reminders": [ ],
"lastReminder": null,
"visitorCount": [ ],
"candidateVerifiers": [ ]
}
},
"board": {"name": "string",
"description": "string",
"addedRoles": [null
],
"removedRoles": [null
],
"audienceFilters": [null
],
"permissions": {"write": null
},
"id": 0,
"createTime": "2019-08-24T14:15:22Z",
"updateTime": "2019-08-24T14:15:22Z",
"creator": {"name": "George Clooney",
"obfuscatedId": "abc123"
},
"updatedBy": {"name": "George Clooney",
"obfuscatedId": "abc123"
},
"itemCount": 0,
"roles": [null
]
},
"collections": [{"name": null,
"description": null,
"addedRoles": [ ],
"removedRoles": [ ],
"audienceFilters": [ ],
"icon": null,
"adminLocked": null,
"parentId": null,
"thumbnail": null,
"allowedDatasource": null,
"permissions": null,
"id": null,
"createTime": null,
"updateTime": null,
"creator": null,
"updatedBy": null,
"itemCount": null,
"childCount": null,
"items": [ ],
"pinMetadata": null,
"shortcuts": [ ],
"children": [ ],
"roles": [ ]
}
],
"documentCategory": "string",
"sourceDocument": {"id": "string",
"datasource": "string",
"connectorType": "API_CRAWL",
"docType": "string",
"content": {"fullTextList": [ ]
},
"containerDocument": { },
"parentDocument": { },
"title": "string",
"url": "string",
"metadata": {"container": "container",
"parentId": "JIRA_EN-1337",
"createTime": "2000-01-23T04:56:07.000Z",
"datasource": "datasource",
"author": {"name": "name"
},
"documentId": "documentId",
"updateTime": "2000-01-23T04:56:07.000Z",
"mimeType": "mimeType",
"objectType": "Feature Request",
"components": ["Backend",
"Networking"
],
"status": ["Done"
],
"customData": {"someCustomField": "someCustomValue"
}
},
"sections": [null
]
}
},
"extractedQnA": {"heading": "string",
"question": "string",
"questionResult": {"snippets": [{"snippet": "snippet",
"mimeType": "mimeType"
}
],
"metadata": {"container": "container",
"createTime": "2000-01-23T04:56:07.000Z",
"datasource": "datasource",
"author": {"name": "name"
},
"documentId": "documentId",
"updateTime": "2000-01-23T04:56:07.000Z",
"mimeType": "mimeType",
"objectType": "objectType"
},
"title": "title",
"url": "https://example.com/foo/bar",
"nativeAppUrl": "slack://foo/bar",
"mustIncludeSuggestions": [{"missingTerm": "container",
"query": "container"
}
]
}
},
"meeting": {"id": "string",
"title": "string",
"description": "string",
"url": "string",
"startTime": "2019-08-24T14:15:22Z",
"endTime": "2019-08-24T14:15:22Z",
"attendees": {"people": [null
],
"isLimit": true,
"total": 0,
"numAccepted": 0,
"numDeclined": 0,
"numNoResponse": 0,
"numTentative": 0
}
},
"app": {"datasource": "string",
"docType": "string",
"mimeType": "string",
"iconUrl": "string"
},
"collection": {"name": "string",
"description": "string",
"addedRoles": [{"sourceDocumentSpec": null,
"person": null,
"group": null,
"role": null
}
],
"removedRoles": [{"sourceDocumentSpec": null,
"person": null,
"group": null,
"role": null
}
],
"audienceFilters": [{"fieldName": "type",
"values": [{"value": "Spreadsheet",
"relationType": "EQUALS"
},
{"value": "Presentation",
"relationType": "EQUALS"
}
]
}
],
"icon": "string",
"adminLocked": true,
"parentId": 0,
"thumbnail": {"photoId": "string",
"url": "string"
},
"allowedDatasource": "string",
"permissions": {"write": {"scopeType": null,
"create": null,
"update": null,
"delete": null
}
},
"id": 0,
"createTime": "2019-08-24T14:15:22Z",
"updateTime": "2019-08-24T14:15:22Z",
"creator": {"name": "George Clooney",
"obfuscatedId": "abc123"
},
"updatedBy": {"name": "George Clooney",
"obfuscatedId": "abc123"
},
"itemCount": 0,
"childCount": 0,
"items": [{"name": null,
"description": null,
"icon": null,
"collectionId": null,
"documentId": null,
"url": null,
"itemId": null,
"createdBy": null,
"createdAt": null,
"document": null,
"shortcut": null,
"collection": null,
"itemType": null
}
],
"pinMetadata": {"existingPins": [null
],
"eligiblePins": [null
]
},
"shortcuts": ["string"
],
"children": [null
],
"roles": [{"sourceDocumentSpec": null,
"person": null,
"group": null,
"role": null
}
]
},
"answerBoard": {"name": "string",
"description": "string",
"addedRoles": [{"sourceDocumentSpec": null,
"person": null,
"group": null,
"role": null
}
],
"removedRoles": [{"sourceDocumentSpec": null,
"person": null,
"group": null,
"role": null
}
],
"audienceFilters": [{"fieldName": "type",
"values": [{"value": "Spreadsheet",
"relationType": "EQUALS"
},
{"value": "Presentation",
"relationType": "EQUALS"
}
]
}
],
"permissions": {"write": {"scopeType": null,
"create": null,
"update": null,
"delete": null
}
},
"id": 0,
"createTime": "2019-08-24T14:15:22Z",
"updateTime": "2019-08-24T14:15:22Z",
"creator": {"name": "George Clooney",
"obfuscatedId": "abc123"
},
"updatedBy": {"name": "George Clooney",
"obfuscatedId": "abc123"
},
"itemCount": 0,
"roles": [{"sourceDocumentSpec": null,
"person": null,
"group": null,
"role": null
}
]
},
"code": {"repoName": "scio",
"fileName": "README.md",
"matches": [{"lineNumber": 1,
"content": "Welcome to the beginning",
"ranges": [ ]
},
{"lineNumber": 2,
"content": "Second line of the file",
"ranges": [ ]
},
{"lineNumber": 3,
"content": "hello world hello world",
"ranges": [{"startindex": 0,
"endIndex": 5
},
{"startIndex": 12,
"endIndex": 17
}
]
}
]
},
"shortcut": {"id": 0,
"inputAlias": "string",
"destinationUrl": "string",
"destinationDocumentId": "string",
"description": "string",
"unlisted": true,
"urlTemplate": "string",
"addedRoles": [{"sourceDocumentSpec": null,
"person": null,
"group": null,
"role": null
}
],
"removedRoles": [{"sourceDocumentSpec": null,
"person": null,
"group": null,
"role": null
}
],
"permissions": {"write": {"scopeType": null,
"create": null,
"update": null,
"delete": null
}
},
"createdBy": {"name": "George Clooney",
"obfuscatedId": "abc123"
},
"createTime": "2019-08-24T14:15:22Z",
"updatedBy": {"name": "George Clooney",
"obfuscatedId": "abc123"
},
"updateTime": "2019-08-24T14:15:22Z",
"destinationDocument": {"id": "string",
"datasource": "string",
"connectorType": "API_CRAWL",
"docType": "string",
"content": {"fullTextList": [ ]
},
"containerDocument": { },
"parentDocument": { },
"title": "string",
"url": "string",
"metadata": {"container": "container",
"parentId": "JIRA_EN-1337",
"createTime": "2000-01-23T04:56:07.000Z",
"datasource": "datasource",
"author": {"name": "name"
},
"documentId": "documentId",
"updateTime": "2000-01-23T04:56:07.000Z",
"mimeType": "mimeType",
"objectType": "Feature Request",
"components": ["Backend",
"Networking"
],
"status": ["Done"
],
"customData": {"someCustomField": "someCustomValue"
}
},
"sections": [null
]
},
"intermediateUrl": "string",
"viewPrefix": "string",
"isExternal": true,
"editUrl": "string",
"alias": "string",
"title": "string",
"roles": [{"sourceDocumentSpec": null,
"person": null,
"group": null,
"role": null
}
]
},
"querySuggestions": {"suggestions": [{"query": "app:github type:pull author:mortimer",
"label": "Mortimer's PRs",
"datasource": "github"
}
],
"person": {"name": "George Clooney",
"obfuscatedId": "abc123"
}
},
"relatedDocuments": [{"relation": "ATTACHMENT",
"associatedEntityId": "string",
"querySuggestion": {"query": "app:github type:pull author:mortimer",
"label": "Mortimer's PRs",
"datasource": "github"
},
"documents": [null
],
"results": [null
]
}
],
"relatedQuestion": {"question": "string",
"answer": "string",
"ranges": [{"startIndex": null,
"endIndex": null,
"type": null,
"url": null,
"document": null
}
]
},
"disambiguation": {"name": "string",
"id": "string",
"type": "PERSON"
},
"snippets": [{"snippet": "snippet",
"mimeType": "mimeType"
}
],
"trackingToken": "string",
"prominence": "HERO",
"source": "EXPERT_DETECTION"
}
}
]
},
"emoji": "string",
"thumbnail": {"photoId": "string",
"url": "string"
},
"banner": {"photoId": "string",
"url": "string"
},
"audienceFilters": [{"fieldName": "type",
"values": [{"value": "Spreadsheet",
"relationType": "EQUALS"
},
{"value": "Presentation",
"relationType": "EQUALS"
}
]
}
],
"sourceDocumentId": "string",
"hideAttribution": true,
"channel": "MAIN",
"postType": "TEXT",
"isPrioritized": true,
"viewUrl": "string",
"draftId": 342,
"permissions": {"write": {"scopeType": "GLOBAL",
"create": true,
"update": true,
"delete": true
}
},
"id": 0,
"author": {"name": "George Clooney",
"obfuscatedId": "abc123"
},
"createTimestamp": 0,
"lastUpdateTimestamp": 0,
"updatedBy": {"name": "George Clooney",
"obfuscatedId": "abc123"
},
"viewerInfo": {"isDismissed": true,
"isRead": true
},
"sourceDocument": {"id": "string",
"datasource": "string",
"connectorType": "API_CRAWL",
"docType": "string",
"content": {"fullTextList": ["string"
]
},
"containerDocument": { },
"parentDocument": { },
"title": "string",
"url": "string",
"metadata": {"container": "container",
"parentId": "JIRA_EN-1337",
"createTime": "2000-01-23T04:56:07.000Z",
"datasource": "datasource",
"author": {"name": "name"
},
"documentId": "documentId",
"updateTime": "2000-01-23T04:56:07.000Z",
"mimeType": "mimeType",
"objectType": "Feature Request",
"components": ["Backend",
"Networking"
],
"status": ["Done"
],
"customData": {"someCustomField": "someCustomValue"
}
},
"sections": [{"title": "string",
"url": "string"
}
]
},
"isPublished": true
}

Create Announcement

header Parameters

Request Body schema: application/jsonrequired

Response Schema: application/json

Request Body schema: application/json
required