Sample request body for createLink api scope USER

Question

Sample request body for createLink api scope USER

Lim Zi Lin 0

I've reviewed the documentation for the createLink API and noticed that it has a USER scope. However, I couldn't find any information about the request body. Can anyone provide an example of the request body?

I have tried using this API with the example request body from chatgpt and it return me 400 Bad Request.

User's image

Here is the link

https://learn.microsoft.com/en-us/graph/api/driveitem-createlink?view=graph-rest-1.0&tabs=http

1 answer

Your answer

Answer 1

Xyza Xue_MSFT 30,241 Microsoft External Staff

Hi @Lim Zi Lin ,

Thank you for posting in this community.

I think you have a bit of a misunderstanding about this API, which I will clarify in more detail below.

User's image Your request body uses three properties, types, scope, and recipients, where the only properties supported by the createLink API are types and scope, and recipients are not supported. Users values are allowed for the scope properties. In other words, the createLink API does not support specifying users.

Here's a screenshot of my test:

User's image

If the answer is helpful, please click "Accept Answer" and kindly upvote it. If you have extra questions about this answer, please click "Comment".

Note: Please follow the steps in our documentation to enable e-mail notifications if you want to receive the related email notification for this thread.

Lim Zi Lin 0 Reputation points

2025-01-27T08:03:20.6933333+00:00

Hi @Xyza Xue_MSFT , Thank you for your clarification! I see where I misunderstood the API now.

Now I'm trying to use another API which is the invite API where I can specifying an external user https://learn.microsoft.com/en-us/graph/api/driveitem-invite?view=graph-rest-1.0&tabs=http, but once i call it, it returned me this Failed to create invitation request.

Do you know why?
Xyza Xue_MSFT 30,241 Reputation points Microsoft External Staff

2025-01-27T08:27:16.82+00:00

Hi, The API content in the documentation needs to be strictly followed. You can't specify a specific drive id in the site, you can only use the Document Library that comes with the site and the item id in it.

POST /sites/{siteId}/drive/items/{itemId}/invite

Here's a screenshot of my test:
Lim Zi Lin 0 Reputation points

2025-01-27T09:15:51.9133333+00:00

Hi, Here is my initial request format

https://graph.microsoft.com/v1.0/sites/{siteId}/drives/{driveId}/items/{itemId}/invite.

If I took out the {drive Id} , and follow this

POST /sites/{siteId}/drive/items/{itemId}/invite

it will returns me this
Xyza Xue_MSFT 30,241 Reputation points Microsoft External Staff

2025-01-28T06:05:11.6866667+00:00
Hi, From your screenshot it looks like the API you are using is:

POST /sites/{siteId}/drives/items/{itemId}/invite

The official documentation gives the API as:

POST /sites/{siteId}/drive/items/{itemId}/invite

Also make sure that the itemid used can be queried using this API:

https://graph.microsoft.com/v1.0/drives/shared documents id/root/children
Xyza Xue_MSFT 30,241 Reputation points Microsoft External Staff

2025-01-29T06:04:24.57+00:00

Hi @Lim Zi Lin ,

How's going today? Do you have further concerns regarding this issue? Please feel free to talk with us if you have other questions. If the above info is helpful to this question, you can click "Accept Answer". Have a nice day!
Xyza Xue_MSFT 30,241 Reputation points Microsoft External Staff

2025-01-31T08:19:15.1866667+00:00

Hi @Lim Zi Lin ,

Do you have further concerns regarding this issue? Please feel free to talk with us if you have other questions.
Lim Zi Lin 0 Reputation points

2025-02-06T08:23:30.6533333+00:00

Hi @Xyza Xue_MSFT , thanks for your response.
I tried the API you provided, and it returned the same result.

POST /sites/{siteId}/drive/items/{itemId}/invite

Could you provide more information about how to use this API?

https://graph.microsoft.com/v1.0/drives/shared documents id/root/children
Xyza Xue_MSFT 30,241 Reputation points Microsoft External Staff

2025-02-06T08:57:46.1033333+00:00

Hi, please refer to https://learn.microsoft.com/en-us/graph/api/driveitem-list-children?view=graph-rest-1.0&tabs=http

Share via

Sample request body for createLink api scope USER

1 answer

Your answer