ShopEazydevelopers
API referenceMerchant API BetaSocial

Edit a draft, scheduled or failed post

Beta
Credentials
  • OAuth access token
Scopes
marketing:write
Subscription
Needs an active plan. Otherwise 403 subscription_locked.
Idempotency
Send an Idempotency-Key header. A retry with the same key does the work once.
PATCH
/v1/merchant/stores/{storeId}/social/posts/{postId}

Changes the captions, photos or channels of a post that has not gone out (draft, scheduled, failed or partial). A post that has already gone out is 422 validation_error ("That post has already gone out."). The status does not change: a draft stays a draft, a scheduled post keeps its time (use scheduleSocialPost to change it) and a partial post stays partial, so its published channels are not posted again by publishSocialPost. New photos must be the shop's own (already on the post, on a listing, or stored by the business): any other link is 422 validation_error. Needs a connected Facebook Page.

Access: OAuth scope marketing:write; write-gated by the subscription.

Authorization

merchantOAuth marketing:write
headerAuthorizationBearer <token>

OAuth 2.1 (authorization code + PKCE S256, public clients, dynamic registration) for connected AI apps. Effective power is scopes granted AND the person's role today AND the plan. orders:refund, billing:write and team:write are opt-in on the consent screen. Write implies read for marketing:read and messages:read, so a grant holding marketing:write passes a marketing:read check, and messages:send passes messages:read.

Scope: marketing:write

Path Parameters

storeId*string

A store the person can reach. Any other id answers 404, never 403.

postId*string

Header Parameters

Idempotency-Key*string

Required on every write. Minted on the device when the person taps, reused on every retry. A write without one, or with one that does not match the pattern, is refused with 422 validation_error. Scoped to the token's subject, remembered 24 hours. A replay returns the first 2xx response with Idempotent-Replay: true; a request still running answers 409 in_flight; the same key with a different method, path or body answers 409 idempotency_key_reused; non-2xx results are not remembered. If the key store cannot be read nothing is processed and the answer is 503 idempotency_unavailable: retry with the same key.

Match^[A-Za-z0-9_-]{8,128}$

Request Body

application/json
  1. body

Only what is sent changes. The same checks as createSocialPost apply to the result (422 validation_error, for example Instagram without a photo).

Properties1 <= properties
message?

Both captions, as createSocialPost takes them. The Facebook caption keeps {link} where the product link goes (added at the end when missing).

imageUrls?array<string>

The photos, replacing the old ones. Instagram needs at least one.

channels?array<>

Where it goes.

Items1 <= items

Response Body

OK

application/json
  1. response
data*
Example Request
curl -X PATCH 'https://api.shopeazy.co/v1/merchant/stores/<storeId>/social/posts/<postId>' \  -H 'Authorization: Bearer <access_token>' \  -H 'Idempotency-Key: <unique_key>' \  -H 'Content-Type: application/json' \  -d '{}'
Example Response
{  "data": {    "id": "string",    "status": "draft",    "channels": [      "facebook"    ],    "message": {      "facebook": "string",      "instagram": "string"    },    "imageUrls": [      "string"    ],    "videoUrl": "string",    "linkUrl": "string",    "scheduledAt": 0,    "publishedAt": 0,    "results": {      "property1": {        "status": "pending",        "error": "string",        "permalink": "string"      },      "property2": {        "status": "pending",        "error": "string",        "permalink": "string"      }    },    "createdAt": 0  }}