Accounts

Connected social accounts, whether they can post, and their boards, playlists and subreddits.

List connected accounts

GET/v1/accounts

Parameters

• profileIdstring

Response 200

data []

• idstringrequired
• profileIdstringrequired
• platformstringrequired
• usernamestring
• displayNamestring
• avatarUrlstring (uri)
• statusstringrequired

  Values: active · needs_reconnection · disconnected

• connectedAtstring (date-time)required
• updatedAtstring (date-time)required

curl

curl "https://api.marsial.dev/v1/accounts?profileId=prf_8f2k4d" \
  -H "Authorization: Bearer $MARSIAL_API_KEY"

Node

const res = await fetch('https://api.marsial.dev/v1/accounts?profileId=prf_8f2k4d', {
  headers: {
    Authorization: `Bearer ${process.env.MARSIAL_API_KEY}`,
  },
});
const { data } = await res.json();

Python

import os, requests

res = requests.get(
    "https://api.marsial.dev/v1/accounts?profileId=prf_8f2k4d",
    headers={"Authorization": f"Bearer {os.environ['MARSIAL_API_KEY']}"},
)
data = res.json()["data"]

Get a connected account

GET/v1/accounts/{id}

Parameters

• idstringrequired

Response 200

data

• idstringrequired
• profileIdstringrequired
• platformstringrequired
• usernamestring
• displayNamestring
• avatarUrlstring (uri)
• statusstringrequired

  Values: active · needs_reconnection · disconnected

• connectedAtstring (date-time)required
• updatedAtstring (date-time)required

curl

curl "https://api.marsial.dev/v1/accounts/acc_3k9x2m" \
  -H "Authorization: Bearer $MARSIAL_API_KEY"

Node

const res = await fetch('https://api.marsial.dev/v1/accounts/acc_3k9x2m', {
  headers: {
    Authorization: `Bearer ${process.env.MARSIAL_API_KEY}`,
  },
});
const { data } = await res.json();

Python

import os, requests

res = requests.get(
    "https://api.marsial.dev/v1/accounts/acc_3k9x2m",
    headers={"Authorization": f"Bearer {os.environ['MARSIAL_API_KEY']}"},
)
data = res.json()["data"]

Disconnect an account

DELETE/v1/accounts/{id}

Parameters

• idstringrequired

Response 204

No content

curl

curl -X DELETE "https://api.marsial.dev/v1/accounts/acc_3k9x2m" \
  -H "Authorization: Bearer $MARSIAL_API_KEY"

Node

await fetch('https://api.marsial.dev/v1/accounts/acc_3k9x2m', {
  method: 'DELETE',
  headers: {
    Authorization: `Bearer ${process.env.MARSIAL_API_KEY}`,
  },
});

Python

import os, requests

requests.delete(
    "https://api.marsial.dev/v1/accounts/acc_3k9x2m",
    headers={"Authorization": f"Bearer {os.environ['MARSIAL_API_KEY']}"},
)

Check whether accounts can post

GET/v1/accounts/health

Asks each network right now. Accounts that need reconnecting are updated to needs_reconnection.

Parameters

• profileIdstringrequired

Response 200

data []

• accountIdstringrequired
• platformstringrequired
• statusstringrequired

  Values: healthy · warning · error

• canPostbooleanrequired
• needsReconnectionbooleanrequired
• issuesstring[]required

curl

curl "https://api.marsial.dev/v1/accounts/health?profileId=prf_8f2k4d" \
  -H "Authorization: Bearer $MARSIAL_API_KEY"

Node

const res = await fetch('https://api.marsial.dev/v1/accounts/health?profileId=prf_8f2k4d', {
  headers: {
    Authorization: `Bearer ${process.env.MARSIAL_API_KEY}`,
  },
});
const { data } = await res.json();

Python

import os, requests

res = requests.get(
    "https://api.marsial.dev/v1/accounts/health?profileId=prf_8f2k4d",
    headers={"Authorization": f"Bearer {os.environ['MARSIAL_API_KEY']}"},
)
data = res.json()["data"]

Check whether one account can post

GET/v1/accounts/{id}/health

The same check as the profile’s, for one account. Sites, CRMs and ads connections never take posts (canPost: false).

Parameters

• idstringrequired

Response 200

data

• accountIdstringrequired
• platformstringrequired
• statusstringrequired

  Values: healthy · warning · error

• canPostbooleanrequired
• needsReconnectionbooleanrequired
• issuesstring[]required

curl

curl "https://api.marsial.dev/v1/accounts/acc_3k9x2m/health" \
  -H "Authorization: Bearer $MARSIAL_API_KEY"

Node

const res = await fetch('https://api.marsial.dev/v1/accounts/acc_3k9x2m/health', {
  headers: {
    Authorization: `Bearer ${process.env.MARSIAL_API_KEY}`,
  },
});
const { data } = await res.json();

Python

import os, requests

res = requests.get(
    "https://api.marsial.dev/v1/accounts/acc_3k9x2m/health",
    headers={"Authorization": f"Bearer {os.environ['MARSIAL_API_KEY']}"},
)
data = res.json()["data"]

List boards, playlists, subreddits or flairs

GET/v1/accounts/{id}/{kind}

kind is pinterest-boards, youtube-playlists, reddit-subreddits or reddit-flairs (with subreddit). Use the ids in the post options.

Parameters

• idstringrequired
• kindstringrequired

  Values: pinterest-boards · youtube-playlists · reddit-subreddits · reddit-flairs

• subredditstring

  Required for reddit-flairs.

Response 200

data []

• idstringrequired

  Send it as boardId, playlistId, subreddit or flairId.

• namestringrequired
• detailstring
• isDefaultboolean

  The account's default, used when a post does not pick one.

curl

curl "https://api.marsial.dev/v1/accounts/acc_3k9x2m/{kind}" \
  -H "Authorization: Bearer $MARSIAL_API_KEY"

Node

const res = await fetch('https://api.marsial.dev/v1/accounts/acc_3k9x2m/{kind}', {
  headers: {
    Authorization: `Bearer ${process.env.MARSIAL_API_KEY}`,
  },
});
const { data } = await res.json();

Python

import os, requests

res = requests.get(
    "https://api.marsial.dev/v1/accounts/acc_3k9x2m/{kind}",
    headers={"Authorization": f"Bearer {os.environ['MARSIAL_API_KEY']}"},
)
data = res.json()["data"]

What a CRM account syncs

GET/v1/accounts/{id}/crm-settings

HubSpot accounts take no posts: they turn the people who write to the profile's inbox into contacts and log every message on their timeline.

Parameters

• idstringrequired

Response 200

data

• syncContactsbooleanrequired

  Create a CRM contact for each new person who writes.

• logMessagesbooleanrequired

  Log every inbox message on the contact's timeline.

curl

curl "https://api.marsial.dev/v1/accounts/acc_3k9x2m/crm-settings" \
  -H "Authorization: Bearer $MARSIAL_API_KEY"

Node

const res = await fetch('https://api.marsial.dev/v1/accounts/acc_3k9x2m/crm-settings', {
  headers: {
    Authorization: `Bearer ${process.env.MARSIAL_API_KEY}`,
  },
});
const { data } = await res.json();

Python

import os, requests

res = requests.get(
    "https://api.marsial.dev/v1/accounts/acc_3k9x2m/crm-settings",
    headers={"Authorization": f"Bearer {os.environ['MARSIAL_API_KEY']}"},
)
data = res.json()["data"]

Turn CRM sync on or off

PATCH/v1/accounts/{id}/crm-settings

Parameters

• idstringrequired

Body

• syncContactsboolean

  Create a CRM contact for each new person who writes.

• logMessagesboolean

  Log every inbox message on the contact's timeline.

Response 200

data

• syncContactsbooleanrequired

  Create a CRM contact for each new person who writes.

• logMessagesbooleanrequired

  Log every inbox message on the contact's timeline.

curl

curl -X PATCH "https://api.marsial.dev/v1/accounts/acc_3k9x2m/crm-settings" \
  -H "Authorization: Bearer $MARSIAL_API_KEY"

Node

const res = await fetch('https://api.marsial.dev/v1/accounts/acc_3k9x2m/crm-settings', {
  method: 'PATCH',
  headers: {
    Authorization: `Bearer ${process.env.MARSIAL_API_KEY}`,
  },
});
const { data } = await res.json();

Python

import os, requests

res = requests.patch(
    "https://api.marsial.dev/v1/accounts/acc_3k9x2m/crm-settings",
    headers={"Authorization": f"Bearer {os.environ['MARSIAL_API_KEY']}"},
)
data = res.json()["data"]