title | description | ms.localizationpriority | ms.subservice | doc_type | author |
---|---|---|---|---|---|
Create or replace an activity |
Create a new or replace an existing user activity for your app. |
medium |
project-rome |
apiPageType |
ailae |
Namespace: microsoft.graph
[!INCLUDE beta-disclaimer]
Create a new or replace an existing user activity for your app. If you'd like to create a user activity and its related activityHistoryItems in one request, you can use deep insert.
Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions only if your app requires it. For details about delegated and application permissions, see Permission types. To learn more about these permissions, see the permissions reference.
[!INCLUDE permissions-table]
PUT /me/activities/{appActivityId}
Note: The appActivityId in the URL needs to be URL-safe (all characters except for RFC 2396 unreserved characters must be converted to their hexadecimal representation), but the original appActivityId does not have to be URL-safe.
Name | Type | Description |
---|---|---|
Authorization | string | Bearer {token}. Required. |
In the request body, supply a JSON representation of an activity object.
If successful, this method returns the 201 Created
response code if the activity was created or 200 OK
if the activity was replaced.
The following example shows a request.
PUT https://graph.microsoft.com/beta/me/activities/%2Farticle%3F12345
Content-type: application/json
{
"appActivityId": "/article?12345",
"activitySourceHost": "https://www.contoso.com",
"userTimezone": "Africa/Casablanca",
"appDisplayName": "Contoso, Ltd.",
"activationUrl": "https://www.contoso.com/article?id=12345",
"contentUrl": "https://www.contoso.com/article?id=12345",
"fallbackUrl": "https://www.contoso.com/article?id=12345",
"contentInfo": {
"@context": "https://schema.org",
"@type": "Article",
"author": "Jennifer Booth",
"name": "How to Tie a Reef Knot"
},
"visualElements": {
"attribution": {
"iconUrl": "https://www.contoso.com/icon",
"alternateText": "Contoso, Ltd.",
"addImageQuery": "false"
},
"description": "How to Tie a Reef Knot. A step-by-step visual guide to the art of nautical knot-tying.",
"backgroundColor": "#ff0000",
"displayText": "Contoso How-To: How to Tie a Reef Knot",
"content": {
"$schema": "https://adaptivecards.io/schemas/adaptive-card.json",
"type": "AdaptiveCard",
"body": [
{
"type": "TextBlock",
"text": "Contoso MainPage"
}
]
}
}
}
The following example shows the response.
HTTP/1.1 200 OK
Content-Type: application/json
{
"activitySourceHost": "https://contoso.com",
"createdDateTime": "2017-06-09T20:54:43.969Z",
"lastModifiedDateTime": "2017-06-09T20:54:43.969Z",
"id": "14332800362997268276",
"appActivityId": "/article?12345",
"status": "updated",
"expirationDateTime": "2017-02-26T20:20:48.114Z",
"visualElements": {
"displayText": "Contoso How-To: How to Tie a Reef Knot",
"description": "How to Tie a Reef Knot. A step-by-step visual guide to the art of nautical knot-tying.",
"attribution": {
"iconUrl": "https://www.contoso.com/icon",
"alternateText": "Contoso, Ltd.",
"addImageQuery": "false"
},
"backgroundColor": "#ff0000",
"content": {
"$schema": "https://adaptivecards.io/schemas/adaptive-card.json",
"type": "AdaptiveCard",
"body": [
{
"type": "TextBlock",
"text": "Contoso MainPage"
}
]
}
},
"activationUrl": "https://www.contoso.com/article?id=12345",
"appDisplayName": "Contoso, Ltd.",
"userTimezone": "Africa/Casablanca",
"fallbackUrl": "https://www.contoso.com/article?id=12345",
"contentUrl": "https://www.contoso.com/article?id=12345",
"contentInfo": {
"@context": "https://schema.org",
"@type": "Article",
"author": "Jennifer Booth",
"name": "How to Tie a Reef Knot"
}
}
This example creates a new activity and a history item for that activity in one request.
The following example shows a request.
PUT https://graph.microsoft.com/beta/me/activities/%2Farticle%3F12345
Content-type: application/json
{
"appActivityId": "/article?12345",
"activitySourceHost": "https://www.contoso.com",
"userTimezone": "Africa/Casablanca",
"appDisplayName": "Contoso, Ltd.",
"activationUrl": "https://www.contoso.com/article?id=12345",
"contentUrl": "https://www.contoso.com/article?id=12345",
"fallbackUrl": "https://www.contoso.com/article?id=12345",
"contentInfo": {
"@context": "https://schema.org",
"@type": "Article",
"author": "Jennifer Booth",
"name": "How to Tie a Reef Knot"
},
"visualElements": {
"attribution": {
"iconUrl": "https://www.contoso.com/icon",
"alternateText": "Contoso, Ltd.",
"addImageQuery": "false"
},
"description": "How to Tie a Reef Knot. A step-by-step visual guide to the art of nautical knot-tying.",
"backgroundColor": "#ff0000",
"displayText": "Contoso How-To: How to Tie a Reef Knot",
"content": {
"$schema": "https://adaptivecards.io/schemas/adaptive-card.json",
"type": "AdaptiveCard",
"body": [
{
"type": "TextBlock",
"text": "Contoso MainPage"
}
]
}
},
"historyItems": [
{
"userTimezone": "Africa/Casablanca",
"startedDateTime": "2018-02-26T20:54:04.345Z",
"lastActiveDateTime": "2018-02-26T20:54:24.345Z"
}
]
}
The following example shows the response.
HTTP/1.1 200 OK
Content-Type: application/json
{
"activitySourceHost": "https://contoso.com",
"createdDateTime": "2017-06-09T20:54:43.969Z",
"lastModifiedDateTime": "2017-06-09T20:54:43.969Z",
"id": "14332800362997268276",
"appActivityId": "/article?12345",
"status": "updated",
"expirationDateTime": "2017-02-26T20:20:48.114Z",
"visualElements": {
"displayText": "Contoso How-To: How to Tie a Reef Knot",
"description": "How to Tie a Reef Knot. A step-by-step visual guide to the art of nautical knot-tying.",
"attribution": {
"iconUrl": "https://www.contoso.com/icon",
"alternateText": "Contoso, Ltd.",
"addImageQuery": "false"
},
"backgroundColor": "#ff0000",
"content": {
"$schema": "https://adaptivecards.io/schemas/adaptive-card.json",
"type": "AdaptiveCard",
"body": [
{
"type": "TextBlock",
"text": "Contoso MainPage"
}
]
}
},
"activationUrl": "https://www.contoso.com/article?id=12345",
"appDisplayName": "Contoso, Ltd.",
"userTimezone": "Africa/Casablanca",
"fallbackUrl": "https://www.contoso.com/article?id=12345",
"contentUrl": "https://www.contoso.com/article?id=12345",
"contentInfo": {
"@context": "https://schema.org",
"@type": "Article",
"author": "Jennifer Booth",
"name": "How to Tie a Reef Knot"
},
"historyItems": [
{
"status": "updated",
"userTimezone": "Africa/Casablanca",
"createdDateTime": "2018-04-12T21:42:42.495Z",
"lastModifiedDateTime": "2018-04-12T21:42:42.495Z",
"id": "61fc8f36-919f-4b73-89d4-1cb7b159d912",
"startedDateTime": "2018-02-26T20:54:04.345Z",
"lastActiveDateTime": "2018-02-26T20:54:24.345Z",
"expirationDateTime": "2018-05-12T21:42:42.495Z",
"activeDurationSeconds": 20
}
]
}