REST API reference

For an app connected by sign-in to all of a person's workspaces: every workspace the person is a member of, with their role and what the app may do there. For any other key: its own workspace alone. Pass an id or name from here as X-Postfjord-Workspace.

Key level: read or higher.

Answer

OK

curl https://app.postfjord.com/api/v1/workspaces \
  -H "Authorization: Bearer pf_live_..."

The same workspaces as GET /v1/workspaces (at most 50), each with its empty days in the next seven days, failed posts of the last 30 days and posts in a client review. A workspace the key may not read (not an owner there, revoked there, suspended, no API on its plan) is listed with access and message and no numbers. At most 6 calls a minute per key.

Key level: read or higher.

Answer

OK

curl https://app.postfjord.com/api/v1/workspaces/overview \
  -H "Authorization: Bearer pf_live_..."

Call this first: the name confirms the right brand, the timezone is needed to turn a local time into scheduledAt, and paused says whether scheduling and sending are refused right now.

Key level: read or higher.

Answer Workspace

OK

curl https://app.postfjord.com/api/v1/workspace \
  -H "Authorization: Bearer pf_live_..."

Key level: read or higher.

Answer array of Channel

OK

curl https://app.postfjord.com/api/v1/channels \
  -H "Authorization: Bearer pf_live_..."

Key level: read or higher.

Answer BrandProfile

OK

curl https://app.postfjord.com/api/v1/brand \
  -H "Authorization: Bearer pf_live_..."

from and to filter on scheduledAt. Drafts without a date come with status=draft.

Key level: read or higher.

Parameters

Answer array of Post

OK

curl https://app.postfjord.com/api/v1/posts \
  -H "Authorization: Bearer pf_live_..."

Drafts are safe: nothing goes out until a person schedules or publishes it. A key with the draft scope gets 403 when scheduledAt is set.

Key level: draft or higher.

Parameters

Body PostInput

Answer Post

The created post. A scheduled post that asks readers to comment a word nothing answers on a channel also gets warnings, as for updatePost.

curl -X POST https://app.postfjord.com/api/v1/posts \
  -H "Authorization: Bearer pf_live_..." \
  -H "Content-Type: application/json" \
  -d '{"baseText":"...","channelIds":["..."]}'

Key level: read or higher.

Parameters

Answer Post

OK

curl https://app.postfjord.com/api/v1/posts/<id> \
  -H "Authorization: Bearer pf_live_..."

Send only the fields to change. scheduledAt: null turns a scheduled post back into a draft. Setting scheduledAt needs the publish scope. A body with bioLink alone changes the post's link in Latest posts, also on a published post (publish scope). A body with videoPage alone switches the post's video page, also on a published post (publish scope). When the post ends up scheduled and asks readers to comment a word to get something on a channel where nothing answers that word (no comment to DM there, or no automation that is on for the word), the answer has warnings: [{ code: noCommentDm or noAutomation, channelId, platform, word, message }]. A warning never stops the schedule.

Key level: draft or higher.

Parameters

Body PostInput

Answer Post

The updated post

curl -X PATCH https://app.postfjord.com/api/v1/posts/<id> \
  -H "Authorization: Bearer pf_live_..." \
  -H "Content-Type: application/json" \
  -d '{"baseText":"...","channelIds":["..."]}'

Key level: draft or higher.

Parameters

Answer

OK

curl -X DELETE https://app.postfjord.com/api/v1/posts/<id> \
  -H "Authorization: Bearer pf_live_..."

Key level: draft or higher.

Parameters

Answer Post

The cancelled post

curl -X POST https://app.postfjord.com/api/v1/posts/<id>/cancel \
  -H "Authorization: Bearer pf_live_..."

Key level: read or higher.

Parameters

Answer PublishLog

OK

curl https://app.postfjord.com/api/v1/posts/<id>/log \
  -H "Authorization: Bearer pf_live_..."

Per switched-on channel, the file it will send for each picture, as signed links valid one hour. With a key that may write drafts, a file that is missing is made now, as publishing would make it (at most 60 per post and 500 per workspace a day, and not while the workspace storage is full). With a read-only key nothing is made: a missing file is named in errors. Show these to the person before scheduling. Nothing on the post changes.

Key level: read or higher.

Parameters

Answer PostPreviews

OK

curl https://app.postfjord.com/api/v1/posts/<id>/previews \
  -H "Authorization: Bearer pf_live_..."

Goes out to every channel on the post at once. Ask the person before calling this.

Key level: publish or higher.

Parameters

Answer

Result and the post

curl -X POST https://app.postfjord.com/api/v1/posts/<id>/publish \
  -H "Authorization: Bearer pf_live_..."

reschedule moves scheduled posts, and drafts that have a date, by shift or so the earliest starts at startAt and the others keep their spacing. It needs the publish scope and is refused while the workspace is paused. A suspended workspace moves nothing. draft takes scheduled or cancelled posts out of the queue as drafts that keep their date, cancel cancels scheduled posts, delete removes drafts, cancelled, failed and scheduled posts (with the draft scope only drafts and cancelled posts, as DELETE /v1/posts/{id}). Posts being published or already published are never changed. Every post gets its own result: done, same (it already was what the action makes) or skipped with a code: not_found, publishing, published, status, no_date, not_scheduled, went_live, key_scope, past, month_full, x_addon, changed or error. Send a requestId of your own to make a retry move each post only once.

Key level: draft or higher.

Parameters

Body

Answer

A result per post, in the order sent

curl -X POST https://app.postfjord.com/api/v1/posts/bulk \
  -H "Authorization: Bearer pf_live_..." \
  -H "Content-Type: application/json" \
  -d '{"action":"reschedule","postIds":["..."]}'

Notes mark days for the whole workspace, such as a sale, a holiday or a course start. from and to are days in the workspace time zone, both included, at most 400 days apart.

Key level: read or higher.

Parameters

Answer

The notes, earliest first

curl https://app.postfjord.com/api/v1/calendar-notes \
  -H "Authorization: Bearer pf_live_..."

A note for one day (leave out to) or up to 90 days in a row. It sends nothing. A workspace keeps at most 1000 notes.

Key level: draft or higher.

Parameters

Body CalendarNoteInput

Answer

The note

curl -X POST https://app.postfjord.com/api/v1/calendar-notes \
  -H "Authorization: Bearer pf_live_..." \
  -H "Content-Type: application/json" \
  -d '{}'

Send only what changes. from without to moves the whole note and keeps how many days it covers.

Key level: draft or higher.

Parameters

Body CalendarNoteInput

Answer

The note

curl -X PATCH https://app.postfjord.com/api/v1/calendar-notes/<id> \
  -H "Authorization: Bearer pf_live_..." \
  -H "Content-Type: application/json" \
  -d '{}'

Key level: draft or higher.

Parameters

Answer

OK

curl -X DELETE https://app.postfjord.com/api/v1/calendar-notes/<id> \
  -H "Authorization: Bearer pf_live_..."

Every file, whatever its state, unless status narrows it. Before 2026-09-30 only ready files were listed: send status=ready for the files a post can use now.

Key level: read or higher.

Parameters

Answer array of Media

OK

curl https://app.postfjord.com/api/v1/media \
  -H "Authorization: Bearer pf_live_..."

Two ways to send the file. 1) JSON { url, name?, alt? }: Postfjord downloads the file from a public http(s) address that answers with the file itself. Private and internal addresses are refused, redirects are followed up to 5 times, and the download must finish within 50 seconds. 2) The file itself as the request body, with its Content-Type, and name and alt as query parameters if you like. At most 30 MB this way: one request to Cloud Functions carries at most 32 MB, so send a bigger video as a url. JPEG, PNG, WebP, GIF, MP4 or MOV, checked on the file's own bytes. A picture is at most 50 MB and a video at most 500 MB, within the storage of the workspace's plan. At most 30 uploads a minute and 500 a day per workspace. The answer comes when the file is stored, with status processing: the thumbnails, picture size and video length follow within seconds (GET /v1/media/{id}). A draft can use the id in mediaIds straight away; scheduling a post waits until its files are ready. Send files one after another rather than many at once.

Key level: draft or higher.

Parameters

Body MediaUpload

Answer

Stored, and processing

curl -X POST https://app.postfjord.com/api/v1/media \
  -H "Authorization: Bearer pf_live_..." \
  -H "Content-Type: application/json" \
  -d '{"url":"..."}'

Key level: read or higher.

Parameters

Answer Media

OK

curl https://app.postfjord.com/api/v1/media/<id> \
  -H "Authorization: Bearer pf_live_..."

Resize, like Magic Resize: the picture is rendered from its original once per shape, at up to 2160 px on the long side, and each result is saved as a new picture in the media library named after the original and the shape ("Beach day 9x16"). The original never changes. A size is a shape for the automatic crop (Postfjord picks the best part), or an object with mode crop, focus { x, y } from 0 to 1 and zoom 1 to 4, or mode whole: the whole picture on a soft blurred copy of itself, for pictures where a crop would cut people or words. At most one of each shape in a call. A picture uploaded a moment ago is waited for up to 30 seconds. The answer comes once the files are saved; each is ready a few seconds later (GET /v1/media/{id}). The new files count toward the plan's storage, and each plan makes a number of resized pictures a day (Free 24, Solo 100, Studio 250, Agency 500); over it the call is refused with resource-exhausted. When some sizes could not be made the others are kept and listed in failed.

Key level: draft or higher.

Parameters

Body

Answer

Saved

curl -X POST https://app.postfjord.com/api/v1/media/<id>/resize \
  -H "Authorization: Bearer pf_live_..." \
  -H "Content-Type: application/json" \
  -d '{"sizes":["..."]}'

Make it a reel: one picture, or up to 10, become a 1080x1920 MP4 (H.264, 30 frames a second, no sound) with a slow zoom on each picture toward the point kept in the post's fit, soft fades between them and, if you send text, a short line in the brand kit's font and colours. Send mediaIds (pictures in the library), or postId to use that post's pictures, its text and how each channel crops them. With postId this makes a story or a reel from a post that already exists, of any status: the post itself never changes. The video is 5 to 30 seconds: 6 for one picture, about 3 a picture for more, or seconds. The answer comes at once with the new media id and draft id: the draft holds the video right away, and the video is ready about a minute later (GET /v1/media/{id}, status ready; failed with error if it could not be made). A reel draft goes to the post's channels that show short videos, such as Instagram (as a Reel) and Facebook (or channelIds), a story to Instagram. Nothing is published: schedule the draft when the video is ready. Each plan makes a number of videos a day (Solo 10, Studio 25, Agency 50); over it the call is refused with resource-exhausted.

Key level: draft or higher.

Parameters

Body

Answer

Started

curl -X POST https://app.postfjord.com/api/v1/reels \
  -H "Authorization: Bearer pf_live_..." \
  -H "Content-Type: application/json" \
  -d '{}'

The numbers the app's Analytics screen shows, over 7, 30, 90 or 365 days, cut to what the plan keeps. Per channel: followers and their change, posts, likes and comments, per post and as a rate of followers, and reach per day where the platform shares it. Also the top posts across channels and the best weekday and hour to post in the workspace time zone. notes says what is missing and why.

Key level: read or higher.

Parameters

Answer Analytics

OK

curl https://app.postfjord.com/api/v1/analytics \
  -H "Authorization: Bearer pf_live_..."

The last 12 weeks and the week in progress (Monday to Sunday, UTC), oldest first. Per week: posts published (with the give or ask split), likes, comments, saves and shares, saves on sampled posts, profile visits, new followers and people reached where Instagram and Facebook share them, new DM conversations, new email subscribers (their own confirmation), first-heard answers per category, landing page views and taps, and link clicks in DMs. A null is a week that was not counted, not a zero. Each signal has its 4-week moving average. story is the last complete week in one sentence, and patterns say per signal whether weeks with more posts had more of it, only when at least 8 complete weeks support it. There is no ROI or attribution figure.

Key level: read or higher.

Answer WeeklySignals

OK

curl https://app.postfjord.com/api/v1/analytics/weekly \
  -H "Authorization: Bearer pf_live_..."

Optional. An agent can write the text itself from GET /v1/brand; this endpoint uses the workspace AI budget. At most 20 per minute per workspace.

Key level: draft or higher.

Body ComposeInput

Answer ComposeResult

OK

curl -X POST https://app.postfjord.com/api/v1/ai/compose \
  -H "Authorization: Bearer pf_live_..." \
  -H "Content-Type: application/json" \
  -d '{"brief":"..."}'

Postfjord's AI writes it from the workspace AI budget, in the brand voice: one AI call for every 5 channels, run at the same time, so a request takes about as long with 12 channels as with 5. Each AI call counts toward the budget. Each post keeps the point in its own text. The posts are saved as drafts, one per channel, with a shared ideaGroupId, and the email as an email draft when email is on and email is true. The website section is returned as text only. Nothing is scheduled or sent. One request writes for at most 12 channels. If some AI calls fail, the drafts from the others are saved and failed names the channels that got none: send the same request again with the same ideaGroupId to write just those. A request that asks for the website section always writes it, since it is never saved. Send your own ideaGroupId (required for more than 5 channels) and repeat it when a request fails (after a timeout, wait 2 minutes first, since that request may still be writing), or to add more channels to the same idea: channels and the email that already have a draft in the group are not written or paid for twice, and when nothing is missing no AI call is made and reused is true. At most 5 requests a minute per workspace.

Key level: draft or higher.

Parameters

Body

Answer

What was written and the drafts made

curl -X POST https://app.postfjord.com/api/v1/ideas/repurpose \
  -H "Authorization: Bearer pf_live_..." \
  -H "Content-Type: application/json" \
  -d '{}'

Each goal with its plan, planHash, the parts a launch made (assets) and the last counted results. Goals must be open to the workspace's plan; until then the answer is 403.

Key level: read or higher.

Parameters

Answer

OK

curl https://app.postfjord.com/api/v1/goals \
  -H "Authorization: Bearer pf_live_..."

Say what you want to achieve. Postfjord plans posts over the period, a comment to DM automation, a landing page with a signup form and 1 to 3 welcome emails, on the workspace's AI budget. Nothing is created except the goal itself, with status proposed. Show the plan to the person and launch it only after they say yes. missing names what the workspace lacks (dm_channel, postmail, pages, link); those parts are left out. It also names keyword when no post asks for the DM's word, and emails_no_way_in when the emails were left out because nothing could start them.

Key level: draft or higher.

Parameters

Body

Answer

The goal with its plan and planHash

curl -X POST https://app.postfjord.com/api/v1/goals \
  -H "Authorization: Bearer pf_live_..." \
  -H "Content-Type: application/json" \
  -d '{"text":"..."}'

Key level: read or higher.

Parameters

Answer

OK

curl https://app.postfjord.com/api/v1/goals/<id> \
  -H "Authorization: Bearer pf_live_..."

Send the whole plan (posts, automation, page, emails) as GET returned it, with your changes. It is cleaned as the AI's plan is, and the answer has the new planHash. A keyword or page address another automation or page uses is refused. A launched goal's plan cannot change.

Key level: draft or higher.

Parameters

Body

Answer

OK

curl -X PATCH https://app.postfjord.com/api/v1/goals/<id> \
  -H "Authorization: Bearer pf_live_..." \
  -H "Content-Type: application/json" \
  -d '{"plan":{}}'

Counted from what the parts keep, at most every five minutes.

Key level: read or higher.

Parameters

Answer

OK

curl https://app.postfjord.com/api/v1/goals/<id>/results \
  -H "Authorization: Bearer pf_live_..."

Makes the tag, signup form, landing page, welcome emails, comment to DM automation and posts, each once: a second call finds what exists. planHash must be the one from the plan the person approved. Posts stay drafts on their dates unless postsAs is scheduled. The landing page is published when the posts are scheduled, the automation is switched on or the emails start, because they link to it; when its publish is refused, the automation and the emails stay off. The automation stays off unless turnOnAutomation is true, and the emails stay stopped unless startEmails is true. Every address is confirmed by double opt-in. Refused while the workspace is paused, and when a part would pass the plan's limits, in which case nothing is made. notes says what is off and why.

Key level: publish or higher.

Parameters

Body

Answer

The launched goal and notes

curl -X POST https://app.postfjord.com/api/v1/goals/<id>/launch \
  -H "Authorization: Bearer pf_live_..." \
  -H "Content-Type: application/json" \
  -d '{"planHash":"..."}'

Posts not yet out are cancelled, the automation switched off, the emails paused, the form switched off and the page taken offline. Contacts, tags and consents stay. Works while the workspace is paused. A Flow built step by step is turned off instead: it becomes a draft that can go live again, and its page stays online unless takePageDown is true. With mode close it closes to new signups: nobody new joins, its emails keep going to the people already in, and it stays live with closedAt set until a launch opens it again.

Key level: publish or higher.

Parameters

Body

Answer

OK

curl -X POST https://app.postfjord.com/api/v1/goals/<id>/cancel \
  -H "Authorization: Bearer pf_live_..." \
  -H "Content-Type: application/json" \
  -d '{}'

The link in bio page first, then the newest. Also the workspace's address, the plan's landing page limit, the signup forms a page can use and the styles. Landing pages must be switched on for the workspace.

Key level: read or higher.

Parameters

Answer

OK

curl https://app.postfjord.com/api/v1/pages \
  -H "Authorization: Bearer pf_live_..."

A link in bio page (kind bio, one per workspace) or a landing page (kind landing) at slug, within the plan's limit, drafts included. It gets the brand kit's colours on the style. Nothing goes online.

Key level: draft or higher.

Parameters

Body PageInput

Answer PageWrite

The new draft and its checks

curl -X POST https://app.postfjord.com/api/v1/pages \
  -H "Authorization: Bearer pf_live_..." \
  -H "Content-Type: application/json" \
  -d '{}'

Key level: read or higher.

Parameters

Answer Page

OK

curl https://app.postfjord.com/api/v1/pages/<id> \
  -H "Authorization: Bearer pf_live_..."

Send only what changes; blocks replaces the whole list. A published page stays live with the published version until it is published again.

Key level: draft or higher.

Parameters

Body PageInput

Answer PageWrite

The draft and its checks

curl -X PATCH https://app.postfjord.com/api/v1/pages/<id> \
  -H "Authorization: Bearer pf_live_..." \
  -H "Content-Type: application/json" \
  -d '{}'

Checks the page (placeholders, wording, images, forms), opens every link and asks Google Web Risk about it, then puts it live. When a check fails nothing is published and ok is false with the errors. At most 20 publishes an hour per workspace. Someone in the workspace must have accepted the page rules in the app first; until then the answer is 409 with that message.

Key level: publish or higher.

Parameters

Answer PagePublish

Published, or the errors that stopped it

curl -X POST https://app.postfjord.com/api/v1/pages/<id>/publish \
  -H "Authorization: Bearer pf_live_..."

Key level: publish or higher.

Parameters

Answer

OK

curl -X POST https://app.postfjord.com/api/v1/pages/<id>/unpublish \
  -H "Authorization: Bearer pf_live_..."

Key level: read or higher.

Answer

OK

curl https://app.postfjord.com/api/v1/mail \
  -H "Authorization: Bearer pf_live_..."

Only id, name, email, consent, tags and createdAt. People who unsubscribed are never listed.

Key level: read or higher.

Parameters

Answer

A page of contacts

curl https://app.postfjord.com/api/v1/mail/contacts \
  -H "Authorization: Bearer pf_live_..."

Key level: read or higher.

Parameters

Answer

A page of campaigns

curl https://app.postfjord.com/api/v1/mail/campaigns \
  -H "Authorization: Bearer pf_live_..."

Blocks are written in the workspace's brand look with its logo on top. A brief goes to Postfjord's AI and uses the workspace AI budget. Nothing is sent. With tags or segment the draft stores who it goes to, and the answer says how many confirmed contacts it reaches (reaches).

Key level: draft or higher.

Parameters

Body

Answer

The draft

curl -X POST https://app.postfjord.com/api/v1/mail/campaigns \
  -H "Authorization: Bearer pf_live_..." \
  -H "Content-Type: application/json" \
  -d '{}'

Key level: read or higher.

Parameters

Answer

The campaign

curl https://app.postfjord.com/api/v1/mail/campaigns/<id> \
  -H "Authorization: Bearer pf_live_..."

Key level: draft or higher.

Parameters

Body

Answer

The draft

curl -X PATCH https://app.postfjord.com/api/v1/mail/campaigns/<id> \
  -H "Authorization: Bearer pf_live_..." \
  -H "Content-Type: application/json" \
  -d '{}'

Counts only. Below 10 deliveries clicks and opens are null.

Key level: read or higher.

Parameters

Answer

The report

curl https://app.postfjord.com/api/v1/mail/campaigns/<id>/report \
  -H "Authorization: Bearer pf_live_..."

Goes to the audience stored on the draft (its tags or segment; everyone who confirmed when it has none) unless segmentId is given. The same checks as the app: sending open for the workspace, the content checks, emails left this month, review of a large first email.

Key level: publish or higher.

Parameters

Body

Answer

Scheduled, or waiting for review

curl -X POST https://app.postfjord.com/api/v1/mail/campaigns/<id>/schedule \
  -H "Authorization: Bearer pf_live_..." \
  -H "Content-Type: application/json" \
  -d '{"when":"..."}'

Key level: publish or higher.

Parameters

Body

Answer

Its new status

curl -X POST https://app.postfjord.com/api/v1/mail/campaigns/<id>/cancel \
  -H "Authorization: Bearer pf_live_..." \
  -H "Content-Type: application/json" \
  -d '{}'

At most 20: id, name, the public link, whether it is on, the tag names people get when they confirm, how many signed up, its welcome automation and the goal it belongs to.

Key level: read or higher.

Answer

The forms

curl https://app.postfjord.com/api/v1/mail/forms \
  -H "Authorization: Bearer pf_live_..."

The answer has the public link. Everyone who signs up gets the double opt-in email first, and the tags (by name; a new name makes the tag) go on when they confirm. Needs email switched on. At most 20 forms a workspace.

Key level: publish or higher.

Parameters

Body

Answer

The form

curl -X POST https://app.postfjord.com/api/v1/mail/forms \
  -H "Authorization: Bearer pf_live_..." \
  -H "Content-Type: application/json" \
  -d '{}'

start turns a draft on: from then on everyone who matches its trigger gets the emails. Starting checks that sending is open, the sender, the trigger and every email, and answers 409 with what to fix. pause stops sending; resume goes on after a pause you made or one for failed checks.

Key level: publish or higher.

Parameters

Body

Answer

The new status

curl -X PATCH https://app.postfjord.com/api/v1/mail/automations/<id> \
  -H "Authorization: Bearer pf_live_..." \
  -H "Content-Type: application/json" \
  -d '{"action":"start"}'

The automations a key can start a person in: on or paused, and started by a tag, a segment, a form, a DM or a click. Automations that start on their own (a date, a referral reward, the email to people who went quiet) are left out.

Key level: read or higher.

Parameters

Answer

The automations

curl https://app.postfjord.com/api/v1/mail/automations \
  -H "Authorization: Bearer pf_live_..."

A series of 1 to 10 emails that go by themselves to each confirmed contact once the trigger starts them: form (someone confirms through a signup form, or any form), tag (a confirmed contact gets the tag, by name; a new name makes the tag) or segment (a saved segment). The emails are written in simple blocks, as POST /v1/mail/campaigns takes them, in the brand look. The first email goes when the person joins unless it has a delay; each later one waits delayDays (default 2) or delayHours after the one before. Nobody gets an email until it is started with PATCH /v1/mail/automations/{id} (publish scope) or in the app. At most 20 a day per workspace and 50 automations in all.

Key level: draft or higher.

Parameters

Body

Answer

The draft

curl -X POST https://app.postfjord.com/api/v1/mail/automations \
  -H "Authorization: Bearer pf_live_..." \
  -H "Content-Type: application/json" \
  -d '{"name":"...","trigger":{"type":"form"},"emails":[{}]}'

Only for an address whose owner confirmed they want your emails, never for a contact with the tag the automation stops on, and only for an automation from GET /v1/mail/automations: one that starts on its own (a date, a referral reward, the email to people who went quiet) answers 409. A person already in it is left where they are (already: true). In a paused automation they wait until it is on. At most 500 starts a workspace and day.

Key level: publish or higher.

Parameters

Body

Answer

Whether it started

curl -X POST https://app.postfjord.com/api/v1/mail/automations/<id>/start \
  -H "Authorization: Bearer pf_live_..." \
  -H "Content-Type: application/json" \
  -d '{"email":"..."}'

Every contact with the address, at most 10. Counts toward the 5,000 contacts a key may read a day.

Key level: read or higher.

Parameters

Answer

The contacts with the address

curl https://app.postfjord.com/api/v1/contacts \
  -H "Authorization: Bearer pf_live_..."

A new contact has no email consent until the person confirms: send askToConfirm to email them the confirmation link. An address that unsubscribed, bounced or was blocked is not added (skipped). Needs the Publish scope, since a change to a contact can start an email automation. At most 2,000 contact changes a workspace and day.

Key level: publish or higher.

Parameters

Body ContactInput

Answer

The contact

curl -X POST https://app.postfjord.com/api/v1/contacts \
  -H "Authorization: Bearer pf_live_..." \
  -H "Content-Type: application/json" \
  -d '{"email":"..."}'

Tags by name; a tag the workspace does not have yet is made. A tag can start an email automation for a confirmed address, so this needs the Publish scope.

Key level: publish or higher.

Parameters

Body

Answer

The contacts and tags

curl -X POST https://app.postfjord.com/api/v1/contacts/tags \
  -H "Authorization: Bearer pf_live_..." \
  -H "Content-Type: application/json" \
  -d '{"email":"...","tags":["..."]}'

Key level: read or higher.

Answer

The tags

curl https://app.postfjord.com/api/v1/tags \
  -H "Authorization: Bearer pf_live_..."

Direct message conversations on Instagram, Messenger and WhatsApp. At most 30 per page; pass nextCursor as cursor for the next page. A filtered page can be short while more remain.

Key level: read or higher.

Parameters

Answer

OK

curl https://app.postfjord.com/api/v1/conversations \
  -H "Authorization: Bearer pf_live_..."

Key level: read or higher.

Parameters

Answer

OK

curl https://app.postfjord.com/api/v1/conversations/<id> \
  -H "Authorization: Bearer pf_live_..."

Nothing is sent. Uses the workspace AI budget. At most 10 per minute per key.

Key level: draft or higher.

Parameters

Body

Answer

The draft

curl -X POST https://app.postfjord.com/api/v1/conversations/<id>/draft-reply \
  -H "Authorization: Bearer pf_live_..." \
  -H "Content-Type: application/json" \
  -d '{}'

Only within 24 hours of the person's last message, never to a person who opted out, at most 10 per minute per key. Refusals come back as failed-precondition with the reason.

Key level: publish or higher.

Parameters

Body

Answer

Sent

curl -X POST https://app.postfjord.com/api/v1/conversations/<id>/reply \
  -H "Authorization: Bearer pf_live_..." \
  -H "Content-Type: application/json" \
  -d '{"text":"..."}'

Key level: read or higher.

Answer

OK

curl https://app.postfjord.com/api/v1/automations \
  -H "Authorization: Bearer pf_live_..."

Creates an automation on Instagram or Facebook that answers nobody until it is switched on with setAutomation (publish scope) or in the app. Steps run in order: message, followGate, collectEmail, followUp, delay, question, addTag ({ type: addTag, tags: [names] }; a tag name the workspace does not have is made) and aiReply (last). Steps that remove a tag, set a field or branch are added in the app. At most 10 a minute per key and 50 a day per workspace.

Key level: draft or higher.

Parameters

Body

Answer

OK, created paused

curl -X POST https://app.postfjord.com/api/v1/automations \
  -H "Authorization: Bearer pf_live_..." \
  -H "Content-Type: application/json" \
  -d '{"name":"...","trigger":{"type":"dm_keyword"},"steps":[{}]}'

Key level: publish or higher.

Parameters

Body

Answer

OK

curl -X PATCH https://app.postfjord.com/api/v1/automations/<id> \
  -H "Authorization: Bearer pf_live_..." \
  -H "Content-Type: application/json" \
  -d '{"enabled":true}'

What the Mentions tab shows: the workspace's own account tagged, reviews, and keywords found on Bluesky and Hacker News, with Postfjord's score. At most 30 per page; pass nextCursor as cursor for the next page. A filtered page can be short while more remain. Duplicates of the same text from another source show only with state=done. Mentions must be open to the workspace's plan; until then the answer is 403.

Key level: read or higher.

Parameters

Answer

OK

curl https://app.postfjord.com/api/v1/mentions \
  -H "Authorization: Bearer pf_live_..."

Key level: read or higher.

Parameters

Answer

OK

curl https://app.postfjord.com/api/v1/mentions/<id> \
  -H "Authorization: Bearer pf_live_..."

Contacts in the order their address came in, from a form, an import, a DM automation or a key. People who unsubscribed are left out. Made for polling, as Zapier and Make do: only the newest rows, each with a stable id, and no cursor. Every call counts toward 10,000 polls a key and day.

Key level: read or higher.

Parameters

Answer

The newest contacts

curl https://app.postfjord.com/api/v1/feeds/contacts \
  -H "Authorization: Bearer pf_live_..."

People who signed up through one of your forms and clicked the confirmation link. Made for polling, as Zapier and Make do: only the newest rows, each with a stable id, and no cursor. Every call counts toward 10,000 polls a key and day.

Key level: read or higher.

Parameters

Answer

The newest signups

curl https://app.postfjord.com/api/v1/feeds/signups \
  -H "Authorization: Bearer pf_live_..."

Paid sales with what sent them and the contact they were credited to. Test purchases are never listed. Made for polling, as Zapier and Make do: only the newest rows, each with a stable id, and no cursor. Every call counts toward 10,000 polls a key and day.

Key level: read or higher.

Parameters

Answer

The newest sales

curl https://app.postfjord.com/api/v1/feeds/sales \
  -H "Authorization: Bearer pf_live_..."

Posts published on every channel they were for, with each channel link. Made for polling, as Zapier and Make do: only the newest rows, each with a stable id, and no cursor. Every call counts toward 10,000 polls a key and day.

Key level: read or higher.

Parameters

Answer

The newest published posts

curl https://app.postfjord.com/api/v1/feeds/posts \
  -H "Authorization: Bearer pf_live_..."

DMs and comments that started a conversation, with a display name and the first words of the latest message. Never an email address. Made for polling, as Zapier and Make do: only the newest rows, each with a stable id, and no cursor. Every call counts toward 10,000 polls a key and day.

Key level: read or higher.

Parameters

Answer

The newest conversations

curl https://app.postfjord.com/api/v1/feeds/conversations \
  -H "Authorization: Bearer pf_live_..."