Collaboration Invites

You can list media collaboration invites from Instagram users. You are able to accept or decline a collaboration invite.

Fetch Collaboration Invites

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

Limitations

  • Collaborator tagging supports Feed Image, Reels and Carousel objects.
  • Stories is not supported.
  • Rate limit applies to 300 calls per Instagram User per day (24 hours).

Requirements

TypeDescription

Access Tokens

User – The Instagram User must be tagged for collaboration of Instagram Media(s) by other Instagram User(s).

Permissions

instagram_basic

Example Request

curl -i -X GET \
"https://graph.facebook.com/v23.0/<IG_USER_ID>/collaboration_invites?access_token=<USER-ACCESS-TOKEN>"

Sample Response

{
  "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"
    }
  }
}

Path Parameters

PlaceholderValue

<API_VERSION>

API version.

<IG_USER_ID>

Required string

The ID for your app user's Instagram User.

Query String Parameters

KeyPlaceholderValue

access_token

Required string

<USER_ACCESS_TOKEN>

Your app user's User access token.

limit

Optional int

<LIMIT> (eg. 15)

Paging limit - Number of items returned in a paged response. Default is 10.

after

Optional string

<AFTER_CURSOR_STRING>

Cursor string to iterate forwards from the current page

before

Optional string

<BEFORE_CURSOR_STRING>

Cursor string to iterate backwards from the current page

Response Fields

Field NameDescription

media_id

The ID of the Instagram Media object tagged for collaboration

media_owner_username

The ID of the Instagram User who invited the app user's Instagram account for collaboration

caption

Caption of the tagged Instagram Media

media_url

Viewable CDN URL of the tagged Instagram Media

Accept Or Decline Collaboration Invite

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

Limitations

  • Accept/Decline collaborations supports Feed Image, Reels and Carousel objects.
  • Stories is not supported.
  • Rate limit applies to 50 calls per Instagram User per day (24 hours).

Requirements

TypeDescription

Access Tokens

User – The Instagram User must be tagged for collaboration of Instagram Media(s) by other Instagram User(s).

Permissions

instagram_basic

Example Request

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>

Sample Response

{
  "success": true
}

Path Parameters

PlaceholderValue

<API_VERSION>

API version.

<IG_USER_ID>

Required string

The ID for your app user's Instagram User.

Query String Parameters

KeyPlaceholderValue

access_token

Required string

<USER_ACCESS_TOKEN>

Your app user's User access token.

media_id

Required string

<IG_MEDIA_ID>

The ID of the invited Instagram Media

accept

Required boolean

boolean

Flag to accept/decline the invite.

  • true to accept the invite
  • false to decline the invite

Response Fields

Field NameDescription

success

Boolean flag to indicate whether the accept/decline succeeded