Read post destinations

social.destinations.read@1

Checks that the accounts you chose can take a text-only post and tells you each platform's limits, so you can write before anything is saved. With incompatible set to report it lists the accounts that cannot instead of refusing the call. It reads and changes nothing. It needs a key with Read social.

Check an account

Send the account's row reference, as its row gives it.

# A new operationId for each new request; the same one to retry it.
curl https://api.growlocal.site/api/v1/profiles/YOUR_BUSINESS_ID/invocations \
  -H "Authorization: Bearer gl_YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "target": {
    "featureId": "YOUR_FEATURE_ID",
    "export": "readDestinations",
    "contractRef": "social.destinations.read@1"
  },
  "operationId": "check-destinations-1",
  "input": {
    "accountRefs": [
      {
        "businessProfileId": "YOUR_BUSINESS_ID",
        "featureId": "juniper-cakes.social",
        "collectionId": "juniper-cakes.accounts",
        "id": "YOUR_ACCOUNT_ID"
      }
    ],
    "format": "post",
    "mediaKind": "none"
  }
}'

// A new operationId for each new request; the same one to retry it.
const response = await fetch(
  "https://api.growlocal.site/api/v1/profiles/YOUR_BUSINESS_ID/invocations",
  {
    method: "POST",
    headers: {
      Authorization: "Bearer gl_YOUR_API_KEY",
      "Content-Type": "application/json",
    },
    body: JSON.stringify({
      "target": {
        "featureId": "YOUR_FEATURE_ID",
        "export": "readDestinations",
        "contractRef": "social.destinations.read@1"
      },
      "operationId": "check-destinations-1",
      "input": {
        "accountRefs": [
          {
            "businessProfileId": "YOUR_BUSINESS_ID",
            "featureId": "juniper-cakes.social",
            "collectionId": "juniper-cakes.accounts",
            "id": "YOUR_ACCOUNT_ID"
          }
        ],
        "format": "post",
        "mediaKind": "none"
      }
    }),
  },
);
const receipt = await response.json();
console.log(response.status, receipt);

import requests

# A new operationId for each new request; the same one to retry it.
response = requests.post(
    "https://api.growlocal.site/api/v1/profiles/YOUR_BUSINESS_ID/invocations",
    headers={"Authorization": "Bearer gl_YOUR_API_KEY"},
    json={
        "target": {
            "featureId": "YOUR_FEATURE_ID",
            "export": "readDestinations",
            "contractRef": "social.destinations.read@1",
        },
        "operationId": "check-destinations-1",
        "input": {
            "accountRefs": [
                {
                    "businessProfileId": "YOUR_BUSINESS_ID",
                    "featureId": "juniper-cakes.social",
                    "collectionId": "juniper-cakes.accounts",
                    "id": "YOUR_ACCOUNT_ID",
                },
            ],
            "format": "post",
            "mediaKind": "none",
        },
    },
    timeout=30,
)
print(response.status_code, response.json())

Parameters

What goes in input:

Response

A call that worked answers 200 with an applied receipt; its output holds these fields, among others. GET /catalog/social.destinations.read@1 answers the complete shape as JSON Schema.

{
  "status": "applied",
  "operationId": "check-destinations-1",
  "output": {
    "destinations": [
      {
        "accountRef": {
          "businessProfileId": "YOUR_BUSINESS_ID",
          "featureId": "juniper-cakes.social",
          "collectionId": "juniper-cakes.accounts",
          "id": "YOUR_ACCOUNT_ID"
        },
        "platform": "x",
        "label": "Juniper Cakes",
        "constraints": {
          "captionLimit": 280,
          "formats": [
            "post"
          ],
          "options": [
            "link"
          ],
          "mediaRequired": false,
          "maxMedia": 4,
          "mediaTypes": [
            "image/jpeg",
            "image/png"
          ]
        }
      }
    ]
  }
}

Errors

It reads and changes nothing. Besides the answers every request can get (Errors), its receipt can say:

The codes in diagnostics you're most likely to see: