Inbox

Direct messages, comments and reviews of a profile’s accounts. Lists take the profile; actions take the account the item belongs to.

List conversations

GET/v1/inbox/conversations

Direct messages on Facebook, Instagram, X, Bluesky, Reddit and Telegram, most recent first.

Parameters

profileIdstringrequired
accountIdstring
statusstring
Values: active · archived
cursorstring
nextCursor of the previous page.
max 4,000
limitinteger
max 100

Response 200

data

itemsobject[]required
items
- idstringrequired
  Opaque conversation id.
- accountIdstringrequired
- platformstringrequired
- participantobjectrequired
  participant
  - namestring
  - usernamestring
  - picturestring (uri)
- lastMessagestring
- updatedAtstring (date-time)
- statusstringrequired
  Values: active · archived
- unreadCountintegerrequired
  max 9,007,199,254,740,991
- urlstring (uri)
  Opens the conversation on the network.
nextCursorstring | nullrequired
Send it as cursor for the next page; null on the last one.

curl "https://api.usecrier.com/v1/inbox/conversations" \
  -H "Authorization: Bearer $CRIER_API_KEY"

const res = await fetch('https://api.usecrier.com/v1/inbox/conversations', {
  headers: {
    Authorization: `Bearer ${process.env.CRIER_API_KEY}`,
  },
});
const { data } = await res.json();

import os, requests

res = requests.get(
    "https://api.usecrier.com/v1/inbox/conversations",
    headers={"Authorization": f"Bearer {os.environ['CRIER_API_KEY']}"},
)
data = res.json()["data"]

List the messages of a conversation

GET/v1/inbox/conversations/{id}/messages

Parameters

idstringrequired
accountIdstringrequired
The account the item belongs to.
cursorstring
nextCursor of the previous page.
max 4,000

Response 200

data

itemsobject[]required
items
- idstringrequired
- directionstringrequired
  Values: incoming · outgoing
- textstringrequired
- senderNamestring
- createdAtstring (date-time)required
- attachmentsobject[]required
  attachments
  - typestringrequired
    Values: image · video · audio · file · sticker · share · other
  - urlstring (uri)
  - namestring
- deliveryStatusstring
- deletedbooleanrequired
nextCursorstring | nullrequired
Send it as cursor for the next page; null on the last one.

curl "https://api.usecrier.com/v1/inbox/conversations/cnv_…/messages" \
  -H "Authorization: Bearer $CRIER_API_KEY"

const res = await fetch('https://api.usecrier.com/v1/inbox/conversations/cnv_…/messages', {
  headers: {
    Authorization: `Bearer ${process.env.CRIER_API_KEY}`,
  },
});
const { data } = await res.json();

import os, requests

res = requests.get(
    "https://api.usecrier.com/v1/inbox/conversations/cnv_…/messages",
    headers={"Authorization": f"Bearer {os.environ['CRIER_API_KEY']}"},
)
data = res.json()["data"]

Send a message

POST/v1/inbox/conversations/{id}/messages

Text, an attachment or both. Meta only lets a page answer within 24 hours of the person’s last message.

Parameters

idstringrequired

Body

accountIdstringrequired
The account the item belongs to.
textstring
max 4,000
attachmentUrlstring (uri)
A public https URL (for example from POST /v1/media/upload-url).
attachmentTypestring
Values: image · video · audio · file

Response 204

No content

curl -X POST "https://api.usecrier.com/v1/inbox/conversations/cnv_…/messages" \
  -H "Authorization: Bearer $CRIER_API_KEY"

const res = await fetch('https://api.usecrier.com/v1/inbox/conversations/cnv_…/messages', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.CRIER_API_KEY}`,
  },
});
const { data } = await res.json();

import os, requests

res = requests.post(
    "https://api.usecrier.com/v1/inbox/conversations/cnv_…/messages",
    headers={"Authorization": f"Bearer {os.environ['CRIER_API_KEY']}"},
)
data = res.json()["data"]

Mark a conversation as read

POST/v1/inbox/conversations/{id}/read

Parameters

idstringrequired

Body

accountIdstringrequired
The account the item belongs to.

Response 204

No content

curl -X POST "https://api.usecrier.com/v1/inbox/conversations/cnv_…/read" \
  -H "Authorization: Bearer $CRIER_API_KEY"

const res = await fetch('https://api.usecrier.com/v1/inbox/conversations/cnv_…/read', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.CRIER_API_KEY}`,
  },
});
const { data } = await res.json();

import os, requests

res = requests.post(
    "https://api.usecrier.com/v1/inbox/conversations/cnv_…/read",
    headers={"Authorization": f"Bearer {os.environ['CRIER_API_KEY']}"},
)
data = res.json()["data"]

Archive or reopen a conversation

PATCH/v1/inbox/conversations/{id}

Parameters

idstringrequired

Body

accountIdstringrequired
The account the item belongs to.
statusstringrequired
Values: active · archived

Response 204

No content

curl -X PATCH "https://api.usecrier.com/v1/inbox/conversations/cnv_…" \
  -H "Authorization: Bearer $CRIER_API_KEY"

const res = await fetch('https://api.usecrier.com/v1/inbox/conversations/cnv_…', {
  method: 'PATCH',
  headers: {
    Authorization: `Bearer ${process.env.CRIER_API_KEY}`,
  },
});
const { data } = await res.json();

import os, requests

res = requests.patch(
    "https://api.usecrier.com/v1/inbox/conversations/cnv_…",
    headers={"Authorization": f"Bearer {os.environ['CRIER_API_KEY']}"},
)
data = res.json()["data"]

List posts with comments

GET/v1/inbox/posts

Recent posts of the profile’s accounts with their comment counts, including posts published outside Crier.

Parameters

profileIdstringrequired
accountIdstring
cursorstring
nextCursor of the previous page.
max 4,000
limitinteger
max 100

Response 200

data

itemsobject[]required
items
- idstringrequired
  Opaque post id for the comment endpoints.
- accountIdstringrequired
- platformstringrequired
- contentstringrequired
- picturestring (uri)
- urlstring (uri)
- createdAtstring (date-time)
- commentCountintegerrequired
  max 9,007,199,254,740,991
- likeCountintegerrequired
  max 9,007,199,254,740,991
nextCursorstring | nullrequired
Send it as cursor for the next page; null on the last one.

curl "https://api.usecrier.com/v1/inbox/posts?profileId=prf_8f2k4d" \
  -H "Authorization: Bearer $CRIER_API_KEY"

const res = await fetch('https://api.usecrier.com/v1/inbox/posts?profileId=prf_8f2k4d', {
  headers: {
    Authorization: `Bearer ${process.env.CRIER_API_KEY}`,
  },
});
const { data } = await res.json();

import os, requests

res = requests.get(
    "https://api.usecrier.com/v1/inbox/posts?profileId=prf_8f2k4d",
    headers={"Authorization": f"Bearer {os.environ['CRIER_API_KEY']}"},
)
data = res.json()["data"]

List the comments of a post

GET/v1/inbox/posts/{id}/comments

Parameters

idstringrequired
accountIdstringrequired
The account the item belongs to.
cursorstring
nextCursor of the previous page.
max 4,000

Response 200

data

itemsobject[]required
items
- idstringrequired
  Opaque comment id.
- textstringrequired
- authorobjectrequired
  author
  - namestring
  - usernamestring
  - picturestring (uri)
  - isOwnerbooleanrequired
    Written by the connected account.
- createdAtstring (date-time)
- likeCountintegerrequired
  max 9,007,199,254,740,991
- replyCountintegerrequired
  max 9,007,199,254,740,991
- urlstring (uri)
- canobjectrequired
  What this network allows on it.
  can
  - replybooleanrequired
  - deletebooleanrequired
  - hidebooleanrequired
  - likebooleanrequired
- hiddenbooleanrequired
- likedbooleanrequired
- repliesobject[]required
  replies
  - idstringrequired
    Opaque comment id.
  - textstringrequired
  - authorobjectrequired
    author
    namestring
    usernamestring
    picturestring (uri)
    isOwnerbooleanrequired
    Written by the connected account.
  - createdAtstring (date-time)
  - likeCountintegerrequired
    max 9,007,199,254,740,991
  - replyCountintegerrequired
    max 9,007,199,254,740,991
  - urlstring (uri)
  - canobjectrequired
    What this network allows on it.
    can
    replybooleanrequired
    deletebooleanrequired
    hidebooleanrequired
    likebooleanrequired
  - hiddenbooleanrequired
  - likedbooleanrequired
nextCursorstring | nullrequired
Send it as cursor for the next page; null on the last one.

curl "https://api.usecrier.com/v1/inbox/posts/thr_…/comments" \
  -H "Authorization: Bearer $CRIER_API_KEY"

const res = await fetch('https://api.usecrier.com/v1/inbox/posts/thr_…/comments', {
  headers: {
    Authorization: `Bearer ${process.env.CRIER_API_KEY}`,
  },
});
const { data } = await res.json();

import os, requests

res = requests.get(
    "https://api.usecrier.com/v1/inbox/posts/thr_…/comments",
    headers={"Authorization": f"Bearer {os.environ['CRIER_API_KEY']}"},
)
data = res.json()["data"]

Comment or reply to a comment

POST/v1/inbox/posts/{id}/comments

Parameters

idstringrequired

Body

accountIdstringrequired
The account the item belongs to.
textstringrequired
max 8,000
commentIdstring
Reply under this comment; omit to comment on the post.

Response 204

No content

curl -X POST "https://api.usecrier.com/v1/inbox/posts/thr_…/comments" \
  -H "Authorization: Bearer $CRIER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "accountId": "acc_3k9x2m",
    "text": "Thank you!"
  }'

const res = await fetch('https://api.usecrier.com/v1/inbox/posts/thr_…/comments', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.CRIER_API_KEY}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "accountId": "acc_3k9x2m",
    "text": "Thank you!"
  }),
});
const { data } = await res.json();

import os, requests

res = requests.post(
    "https://api.usecrier.com/v1/inbox/posts/thr_…/comments",
    headers={"Authorization": f"Bearer {os.environ['CRIER_API_KEY']}"},
    json={
        "accountId": "acc_3k9x2m",
        "text": "Thank you!"
    },
)
data = res.json()["data"]

Hide or like a comment

PATCH/v1/inbox/posts/{id}/comments/{commentId}

Each comment says in can what its network allows.

Parameters

idstringrequired
commentIdstringrequired

Body

accountIdstringrequired
The account the item belongs to.
hiddenboolean
likedboolean

Response 204

No content

curl -X PATCH "https://api.usecrier.com/v1/inbox/posts/thr_…/comments/cmt_…" \
  -H "Authorization: Bearer $CRIER_API_KEY"

const res = await fetch('https://api.usecrier.com/v1/inbox/posts/thr_…/comments/cmt_…', {
  method: 'PATCH',
  headers: {
    Authorization: `Bearer ${process.env.CRIER_API_KEY}`,
  },
});
const { data } = await res.json();

import os, requests

res = requests.patch(
    "https://api.usecrier.com/v1/inbox/posts/thr_…/comments/cmt_…",
    headers={"Authorization": f"Bearer {os.environ['CRIER_API_KEY']}"},
)
data = res.json()["data"]

Delete a comment

DELETE/v1/inbox/posts/{id}/comments/{commentId}

Parameters

idstringrequired
commentIdstringrequired
accountIdstringrequired
The account the item belongs to.

Response 204

No content

curl -X DELETE "https://api.usecrier.com/v1/inbox/posts/thr_…/comments/cmt_…" \
  -H "Authorization: Bearer $CRIER_API_KEY"

await fetch('https://api.usecrier.com/v1/inbox/posts/thr_…/comments/cmt_…', {
  method: 'DELETE',
  headers: {
    Authorization: `Bearer ${process.env.CRIER_API_KEY}`,
  },
});

import os, requests

requests.delete(
    "https://api.usecrier.com/v1/inbox/posts/thr_…/comments/cmt_…",
    headers={"Authorization": f"Bearer {os.environ['CRIER_API_KEY']}"},
)

List mentions

GET/v1/inbox/mentions

Posts and comments by others that tag the profile’s accounts, from the last 7 days: Instagram (accounts connected through Facebook) and LinkedIn pages.

Parameters

profileIdstringrequired
accountIdstring
cursorstring
nextCursor of the previous page.
max 4,000
limitinteger
max 100

Response 200

data

itemsobject[]required
items
- idstringrequired
  Opaque mention id.
- accountIdstringrequired
  The connected account that was mentioned.
- platformstringrequired
- kindstringrequired
  Instagram: tagged in a comment (comment) or in a post caption (caption). LinkedIn: tagged in a post (post).
  Values: comment · caption · post
- contentstringrequired
  The text that mentions the account. Instagram may send it a moment later: empty until then.
- authorobjectrequired
  author
  - namestring
  - usernamestring
  - picturestring (uri)
- urlstring (uri)
  The post that mentions the account (LinkedIn).
- publishedAtstring (date-time)
- canReplybooleanrequired
  Whether POST /v1/inbox/mentions/{id}/reply works on it: Instagram only.
nextCursorstring | nullrequired
Send it as cursor for the next page; null on the last one.

curl "https://api.usecrier.com/v1/inbox/mentions?profileId=prf_8f2k4d" \
  -H "Authorization: Bearer $CRIER_API_KEY"

const res = await fetch('https://api.usecrier.com/v1/inbox/mentions?profileId=prf_8f2k4d', {
  headers: {
    Authorization: `Bearer ${process.env.CRIER_API_KEY}`,
  },
});
const { data } = await res.json();

import os, requests

res = requests.get(
    "https://api.usecrier.com/v1/inbox/mentions?profileId=prf_8f2k4d",
    headers={"Authorization": f"Bearer {os.environ['CRIER_API_KEY']}"},
)
data = res.json()["data"]

Reply to a mention

POST/v1/inbox/mentions/{id}/reply

Instagram only (canReply): replies under the comment that tagged the account, or comments on the post whose caption did.

Parameters

idstringrequired

Body

accountIdstringrequired
The account the item belongs to.
textstringrequired
max 2,200

Response 204

No content

curl -X POST "https://api.usecrier.com/v1/inbox/mentions/mtn_…/reply" \
  -H "Authorization: Bearer $CRIER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "accountId": "acc_3k9x2m",
    "text": "Thanks for the shout-out!"
  }'

const res = await fetch('https://api.usecrier.com/v1/inbox/mentions/mtn_…/reply', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.CRIER_API_KEY}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "accountId": "acc_3k9x2m",
    "text": "Thanks for the shout-out!"
  }),
});
const { data } = await res.json();

import os, requests

res = requests.post(
    "https://api.usecrier.com/v1/inbox/mentions/mtn_…/reply",
    headers={"Authorization": f"Bearer {os.environ['CRIER_API_KEY']}"},
    json={
        "accountId": "acc_3k9x2m",
        "text": "Thanks for the shout-out!"
    },
)
data = res.json()["data"]

List reviews

GET/v1/inbox/reviews

Google Business and Facebook reviews, with their total and average rating.

Parameters

profileIdstringrequired
accountIdstring
cursorstring
nextCursor of the previous page.
max 4,000
limitinteger
max 100
hasReplystring
Only reviews with (true) or without (false) a reply.
Values: true · false

Response 200

data

itemsobject[]required
items
- idstringrequired
  Opaque review id.
- accountIdstringrequired
- platformstringrequired
- reviewerobjectrequired
  reviewer
  - namestring
  - usernamestring
  - picturestring (uri)
- ratinginteger | nullrequired
  1 to 5; null on Facebook, which recommends instead.
- recommendsboolean
- textstringrequired
- createdAtstring (date-time)
- replyobject | nullrequired
  reply
  - textstringrequired
  - createdAtstring (date-time)
- urlstring (uri)
- locationstring
  Google Business location.
nextCursorstring | nullrequired
Send it as cursor for the next page; null on the last one.
summaryobjectrequired
summary
- totalintegerrequired
  max 9,007,199,254,740,991
- averageRatingnumber | nullrequired

curl "https://api.usecrier.com/v1/inbox/reviews" \
  -H "Authorization: Bearer $CRIER_API_KEY"

const res = await fetch('https://api.usecrier.com/v1/inbox/reviews', {
  headers: {
    Authorization: `Bearer ${process.env.CRIER_API_KEY}`,
  },
});
const { data } = await res.json();

import os, requests

res = requests.get(
    "https://api.usecrier.com/v1/inbox/reviews",
    headers={"Authorization": f"Bearer {os.environ['CRIER_API_KEY']}"},
)
data = res.json()["data"]

Reply to a review

POST/v1/inbox/reviews/{id}/reply

Parameters

idstringrequired

Body

accountIdstringrequired
The account the item belongs to.
textstringrequired
max 4,000

Response 204

No content

curl -X POST "https://api.usecrier.com/v1/inbox/reviews/rev_…/reply" \
  -H "Authorization: Bearer $CRIER_API_KEY"

const res = await fetch('https://api.usecrier.com/v1/inbox/reviews/rev_…/reply', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.CRIER_API_KEY}`,
  },
});
const { data } = await res.json();

import os, requests

res = requests.post(
    "https://api.usecrier.com/v1/inbox/reviews/rev_…/reply",
    headers={"Authorization": f"Bearer {os.environ['CRIER_API_KEY']}"},
)
data = res.json()["data"]

Delete a review reply

DELETE/v1/inbox/reviews/{id}/reply

Google Business only.

Parameters

idstringrequired
accountIdstringrequired
The account the item belongs to.

Response 204

No content

curl -X DELETE "https://api.usecrier.com/v1/inbox/reviews/rev_…/reply" \
  -H "Authorization: Bearer $CRIER_API_KEY"

await fetch('https://api.usecrier.com/v1/inbox/reviews/rev_…/reply', {
  method: 'DELETE',
  headers: {
    Authorization: `Bearer ${process.env.CRIER_API_KEY}`,
  },
});

import os, requests

requests.delete(
    "https://api.usecrier.com/v1/inbox/reviews/rev_…/reply",
    headers={"Authorization": f"Bearer {os.environ['CRIER_API_KEY']}"},
)