API reference

Full schemas, bodies, and errors live in the interactive API reference under the Instagram tab. This page is the map.

Authentication

Header	Value
`Authorization`	`Bearer sk_live_xxxxx`
or `x-api-key`	`sk_live_xxxxx`

Instances

What you want	Operation	Scope
List connections	List Instagram instances	`instagram:instances:list`
Create and log in	Create Instagram instance	`instagram:instances:create`
Get detail	Get Instagram instance	`instagram:instances:list`
Session status	Connection status	`instagram:read`
Disconnect	Disconnect session	`instagram:instances:disconnect`
Complete challenge	Resolve challenge	`instagram:instances:create`
Remove	Delete Instagram instance	`instagram:instances:delete`

Messages

What you want	Operation	Scope
Send DM	Send Instagram DM	`instagram:send`
List outbound	List outbound messages	`instagram:read`
Get status	Get outbound message	`instagram:read`
Cancel queue	Cancel queued message	`instagram:cancel`
Edit text	Edit text message	`instagram:update`
Unsend	Unsend message	`instagram:delete`
List inbound	List inbound DMs	`instagram:read`

Comments

What you want	Operation	Scope
List	List comments	`instagram:read`
Reply	Reply to comment	`instagram:comments:reply`
Delete	Delete comment	`instagram:comments:moderate`

Common bodies

Create connection

{
  "name": "Instagram support",
  "acceptInstagramTerms": true,
  "auth": {
    "mode": "password",
    "username": "your_username",
    "password": "your_password"
  }
}

Send text

{
  "instanceId": "inst_abc",
  "to": ["target_user"],
  "type": "text",
  "payload": { "message": "Hello from Notifique!" }
}

Edit text

{ "text": "New text (1 to 1000 characters)" }

Edit limits: 15 minutes, up to 5 edits, text only.

API E-mail

Authentication

Instances

Messages

Comments

Common bodies

Guides

​Authentication

​Instances

​Messages

​Comments

​Common bodies

​Guides

Authentication

Instances

Messages

Comments

Common bodies

Guides