social

Embed
Preview of the card
<a href="https://hermeticor.com/docs/ref-social"><img src="https://hermeticor.com/docs/_api/public/orgs/5fcd8b3c-a27c-4688-972f-de710125592f/spaces/caf5dc05-15f7-4e0c-bdb8-ab29ede6211e/pages/4f753d61-6770-4878-b2fd-ce3457b68fc6/social-card.svg?v=3e7ae33eec8b" alt="social" width="600" height="315"></a>
POSThttps://hermeticor.com/v1/social/posts

Compose a post for one or more accounts: a draft, now, or scheduled. Needs an idempotency key

Request body

application/json
accountIdsstring[]required
textstringrequired
mediaobject[]
= []
Show child parameters
urlstringrequired
typestring
image | video = image
linkstring
scheduledAtstring
draftboolean
= false
idempotencyKeystring
{
  "accountIds": [
    "string"
  ],
  "text": "string",
  "media": [],
  "link": "string",
  "scheduledAt": "2024-01-01T00:00:00Z",
  "draft": false,
  "idempotencyKey": "string"
}

Code samples

cURL
curl -X POST "https://hermeticor.com/v1/social/posts" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"accountIds":["string"],"text":"string","media":[],"link":"string","scheduledAt":"2024-01-01T00:00:00Z","draft":false,"idempotencyKey":"string"}'
TypeScript
Python
Go
PHP
Ruby
Java

Responses

201 Default Response
Example
{
  "items": [
    {
      "id": "string",
      "accountId": "string",
      "groupId": "string",
      "text": "string",
      "media": [
        {
          "url": "string",
          "type": "image"
        }
      ],
      "link": "string",
      "status": "draft",
      "scheduledAt": "string",
      "publishedAt": "string",
      "externalId": "string",
      "url": "string",
      "error": "string",
      "metrics": {},
      "metricsAt": "string",
      "createdAt": "string"
    }
  ]
}
Schema
itemsItemsItem247[]required
Show child parameters
idstringrequired
accountIdstringrequired
groupIdstringrequired
textstringrequired
mediaobject[]required
Show child parameters
urlstringrequired
typestringrequired
image | video
linkstringrequired
statusstringrequired
draft | scheduled | publishing | published | failed | canceled
scheduledAtstringrequired
publishedAtstringrequired
externalIdstringrequired
urlstringrequired
errorstringrequired
metricsobjectrequired
metricsAtstringrequired
createdAtstringrequired
4XX Default Response
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
detailsobject
5XX Default Response

Same as 4XX · POST /v1/social/posts

GEThttps://hermeticor.com/v1/social/posts/{id}

One post with its publish status and metrics

Parameters

idstringpathrequired

Code samples

cURL
curl -X GET "https://hermeticor.com/v1/social/posts/{id}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
Example
{
  "id": "string",
  "accountId": "string",
  "groupId": "string",
  "text": "string",
  "media": [
    {
      "url": "string",
      "type": "image"
    }
  ],
  "link": "string",
  "status": "draft",
  "scheduledAt": "string",
  "publishedAt": "string",
  "externalId": "string",
  "url": "string",
  "error": "string",
  "metrics": {},
  "metricsAt": "string",
  "createdAt": "string"
}
Schema
idstringrequired
accountIdstringrequired
groupIdstringrequired
textstringrequired
mediaobject[]required
Show child parameters
urlstringrequired
typestringrequired
image | video
linkstringrequired
statusstringrequired
draft | scheduled | publishing | published | failed | canceled
scheduledAtstringrequired
publishedAtstringrequired
externalIdstringrequired
urlstringrequired
errorstringrequired
metricsobjectrequired
metricsAtstringrequired
createdAtstringrequired
4XX Default Response

Same as 4XX · POST /v1/social/posts

5XX Default Response

Same as 4XX · POST /v1/social/posts

PATCHhttps://hermeticor.com/v1/social/posts/{id}

Edit or reschedule a draft or scheduled post

Parameters

idstringpathrequired

Request body

application/json
textstring
mediaobject[]
Show child parameters
urlstringrequired
typestring
image | video = image
linkstring
scheduledAtstring
draftboolean
{
  "text": "string",
  "media": [
    {
      "url": "string",
      "type": "image"
    }
  ],
  "link": "string",
  "scheduledAt": "2024-01-01T00:00:00Z",
  "draft": true
}

Code samples

cURL
curl -X PATCH "https://hermeticor.com/v1/social/posts/{id}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"text":"string","media":[{"url":"string","type":"image"}],"link":"string","scheduledAt":"2024-01-01T00:00:00Z","draft":true}'
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response

Same as 200 · GET /v1/social/posts/{id}

4XX Default Response

Same as 4XX · POST /v1/social/posts

5XX Default Response

Same as 4XX · POST /v1/social/posts

POSThttps://hermeticor.com/v1/social/posts/{id}/cancel

Cancel a draft, scheduled or failed post

Parameters

idstringpathrequired

Code samples

cURL
curl -X POST "https://hermeticor.com/v1/social/posts/{id}/cancel" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response

Same as 200 · GET /v1/social/posts/{id}

4XX Default Response

Same as 4XX · POST /v1/social/posts

5XX Default Response

Same as 4XX · POST /v1/social/posts

GEThttps://hermeticor.com/v1/social/posts/{id}/comments

Comments on a published post (pulled with its metrics)

Parameters

limitintegerquery
Page size; omitted returns the whole list
cursorstringquery
Opaque: the nextCursor of the previous page
idstringpathrequired

Code samples

cURL
curl -X GET "https://hermeticor.com/v1/social/posts/{id}/comments" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
Example
{
  "items": [
    {
      "id": "string",
      "externalId": "string",
      "parentExternalId": "string",
      "author": "string",
      "text": "string",
      "postedAt": "string",
      "ours": true
    }
  ],
  "nextCursor": "string"
}
Schema
itemsItemsItem248[]required
Show child parameters
idstringrequired
externalIdstringrequired
parentExternalIdstringrequired
authorstringrequired
textstringrequired
postedAtstringrequired
oursbooleanrequired
nextCursorstringrequired
4XX Default Response

Same as 4XX · POST /v1/social/posts

5XX Default Response

Same as 4XX · POST /v1/social/posts

POSThttps://hermeticor.com/v1/social/posts/{id}/replies

Reply to a comment as the page or account. Needs an idempotency key

Parameters

idstringpathrequired

Request body

application/json
commentIdstringrequired
textstringrequired
idempotencyKeystring
{
  "commentId": "string",
  "text": "string",
  "idempotencyKey": "string"
}

Code samples

cURL
curl -X POST "https://hermeticor.com/v1/social/posts/{id}/replies" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"commentId":"string","text":"string","idempotencyKey":"string"}'
TypeScript
Python
Go
PHP
Ruby
Java

Responses

201 Default Response
Example
{
  "id": "string",
  "externalId": "string",
  "parentExternalId": "string",
  "author": "string",
  "text": "string",
  "postedAt": "string",
  "ours": true
}
Schema
idstringrequired
externalIdstringrequired
parentExternalIdstringrequired
authorstringrequired
textstringrequired
postedAtstringrequired
oursbooleanrequired
4XX Default Response

Same as 4XX · POST /v1/social/posts

5XX Default Response

Same as 4XX · POST /v1/social/posts

Updated