You can list media collaboration invites from Instagram users. You are able to accept or decline a collaboration invite.
Get a list of pending collaboration invites for an Instagram User. These invites are essentially Instagram Media objects (attributes) tagged for collaboration.
Each Media object (attributes) comprises Media ID, Media Owner Instagram Username, Media Caption and Media URL for an Instagram User
GET /<IG_USER_ID>/collaboration_invites
| Type | Description |
|---|---|
User – The Instagram User must be tagged for collaboration of Instagram Media(s) by other Instagram User(s). | |
|
curl -i -X GET \ "https://graph.facebook.com/v23.0/<IG_USER_ID>/collaboration_invites?access_token=<USER-ACCESS-TOKEN>"
{
"data": [
{
"media_id": "18078920227752107",
"media_owner_username": "katrina",
"caption": "Making memories all over the map",
"media_url": "<media-url-1>"
},
{
"media_id": "17938817952064413",
"media_owner_username": "john",
"caption": "Good vibes happen on the tides",
"media_url": "<media-url-2>"
},
{
"media_id": "17981928557731507",
"media_owner_username": "amanda",
"caption": "Less perfection, more authenticity",
"media_url": "<media-url-3>"
}
],
"paging": {
"cursors": {
"before": "QVFIU000NzlGS3BndGdrTzgzb0xoNy1kXzljVGRDRFhlUTNQTjJZARTZAVWWlaQW1RcHN5WUZAtUXQzTnU3dEZAENnoxWkdtOWlaNDA0LXBUcDNXOG90dzR2WXJn",
"after": "QVFIU1lic1ZAkRllCLTktY2wyUzdfb3VaWUdiNUF3TmRacWFaY1k1d2YweWZA4LXpsLUowcjVzaGl2cXljdmlNeG91bEVwVG93RnBKU3IwSW5Xdzh6MFhzZAUFn"
}
}
}| Placeholder | Value |
|---|---|
| API version. |
| The ID for your app user's Instagram User. |
| Key | Placeholder | Value |
|---|---|---|
|
| Your app user's User access token. |
|
| Paging limit - Number of items returned in a paged response. Default is 10. |
|
| Cursor string to iterate forwards from the current page |
|
| Cursor string to iterate backwards from the current page |
| Field Name | Description |
|---|---|
| The ID of the Instagram Media object tagged for collaboration |
| The ID of the Instagram User who invited the app user's Instagram account for collaboration |
| Caption of the tagged Instagram Media |
| Viewable CDN URL of the tagged Instagram Media |
Accept or Decline a pending collaboration invite for an Instagram User for an Instagram post by other Instagram User(s).
Requires API params include API Version, Instagram User ID, invited Media ID and a boolean flag to indicate accept or decline.
POST /<IG_USER_ID>/collaboration_invites
| Type | Description |
|---|---|
User – The Instagram User must be tagged for collaboration of Instagram Media(s) by other Instagram User(s). | |
|
curl -i -X POST \ "https://graph.facebook.com/v23.0/<IG_USER_ID>/collaboration_invites?media_id=<IG_MEDIA_ID>&accept=true&access_token=<USER-ACCESS-TOKEN>
{
"success": true
}| Placeholder | Value |
|---|---|
| API version. |
| The ID for your app user's Instagram User. |
| Key | Placeholder | Value |
|---|---|---|
|
| Your app user's User access token. |
|
| The ID of the invited Instagram Media |
|
| Flag to accept/decline the invite.
|
| Field Name | Description |
|---|---|
| Boolean flag to indicate whether the accept/decline succeeded |