Docs
Social

Unschedule a social post

POSThttps://api.norreach.app/v1/social/posts/{id}/unschedule

Takes a scheduled post off the calendar: it goes back to a draft and nothing goes out. Works while outreach is paused. A post that isn't scheduled answers changed: false; one that is going out right now or published is a conflict (409). dry_run=true checks it and changes nothing.

⚠ social:publishRole must allow: social.publishSupports dry_runOperation id: unschedule_social_post
POST/social/posts/{id}/unschedule
curl -X POST "https://api.norreach.app/v1/social/posts/{id}/unschedule" \
  -H "Authorization: Bearer $NORREACH_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)"
Unschedule a social post
{
  "object": "social_post_action",
  "post_id": "5e6f7a8b-9c0d-4e1f-8a2b-3c4d5e6f7a8b",
  "action": "unschedule",
  "dry_run": false,
  "changed": true,
  "status": "draft",
  "scheduled_at": null,
  "note": "Unscheduled — it is a draft again and nothing goes out."
}

Authorizations

Authorizationstringheaderrequired

Bearer authentication: send Authorization: Bearer <key>, with an API key or an OAuth access token. The key needs the scope social:publish. API keys and scopes

Path parameters

idstring (uuid)pathrequired

An id (UUID).

Query parameters

dry_runbooleanquery

Run every check and return what would happen, changing nothing.

Headers

Idempotency-Keystringheader

Any unique string (≤ 255). The same key with the same request returns the first answer for 24 hours.

Response

200application/json— Unschedule a social post

object"social_post_action"required
post_idstring (uuid)required

An id (UUID).

actionenumrequired
One of:scheduleunscheduledelete
dry_runbooleanrequired
changedbooleanrequired

false when there was nothing to do (or on a dry run).

statusenumrequired

The post's status now (or after it, on a dry run).

One of:ideadraftin_reviewscheduledpublishingpublishedfaileddeleted
scheduled_atstring | nullrequired
notestringrequired

Errors

Errors are application/problem+json with a stable code.

StatusCodeMeaning
400bad_requestThe request couldn't be read.
400unknown_fieldThe request has a field this operation doesn't know.
401unauthorizedA valid API key is required.
403insufficient_scopeThis API key doesn't have the scope this operation needs.
403feature_not_enabledThe API isn't switched on for this workspace.
403role_forbiddenThe key's creator's role can't do this.
404not_foundThat doesn't exist.
409idempotency_in_progressA request with this Idempotency-Key is still running.
409conflictThat conflicts with the current state.
413too_largeThe request body is too large.
422validation_failedThe request has invalid fields.
422idempotency_mismatchThis Idempotency-Key was used with a different request.
429rate_limitedToo many requests. Slow down and try again.
500server_errorSomething went wrong on our side.
503unavailableThe API isn't available right now. Try again shortly.