Skip to content
← Agent action directory

Onboard a client from your CRM

Turn a new client record into a ready-to-use Postly workspace. Your workflow handles setup; the client stays in control of social account authorization.

  1. 1. Choose the organization

    List your organizations and select the organization that will contain the client workspace. Organizations and workspaces have separate identities. Save both IDs in your CRM.

    GET /organizations · postly.list_organizations
  2. 2. Create the client workspace

    Use a clear name such as Acme social team. The API key must have write access to all workspaces; selected-workspace keys cannot create another workspace. The existing workspace allowance applies.

    POST /workspaces · postly.create_workspace
  3. 3. Invite teammates if needed

    A workspace invitation is optional and is not required for a client to use a connection link. Send an invitation to an approved email address with an explicit role. Use EDITOR unless broader management access is intended. An invitation is pending until accepted and does not mean the person has joined.

    POST /workspaces/{id}/invitations · postly.invite_workspace_member
  4. 4. Let the client connect their account

    Generate a private connection link for Facebook, Instagram, Threads, LinkedIn, Google Business Profile, YouTube, Pinterest, TikTok, WhatsApp, X, Blogger, WordPress.com, Discord or Slack. The last four are available through API/MCP only; they do not currently show a dashboard Share link button. It expires after 10 minutes and can be used once. The client needs no Postly account or Postly sign-in. They approve access with the social provider, signing in there only if needed, and select destinations when required. Automation must wait for a confirmed connection. Do not request their social password or place the link in public logs.

    POST /workspaces/{id}/connection-links · postly.create_channel_connection_link
  5. 5. Verify before publishing

    List the workspace channels and confirm a usable publishing destination. Prepare a draft, review the destination and schedule, then approve publishing. Queue acceptance is not delivery; check post status afterward.

    GET /workspaces/{id}/socials · postly.list_social_accounts

Example request from n8n

Use an HTTP Request node with POST, the URL below, an X-API-Key credential stored privately, and a JSON body. Replace the organization ID with one returned for your account.

POST https://openapi.postly.ai/v1/workspaces
X-API-Key: YOUR_API_KEY
Content-Type: application/json

{"organization_id":"YOUR_ORGANIZATION_ID","name":"Acme social team"}

Save the returned workspace ID before the next node. Configure error handling to inspect state after a timeout; do not automatically repeat invitations, workspace deletion or uncertain publishing requests.

Manage changes deliberately

Rename with PATCH /workspaces/{id}. Permanent deletion uses DELETE on the same route and requires confirm_workspace_id to match the workspace ID. Review what will be removed before approving it.

For OAuth MCP connections, request workspace:manage for workspace changes, members:invite for invitations and channels:connect for connection links. Existing connections must approve these permissions. The API key and organization/workspace restrictions remain in force.

Manual credential connections remain in the dashboard. This handoff does not automate provider consent, bypass team capacity or change billing. Read the API reference, MCP guide and live action directory for request fields and available actions.