RelayAPI
Posts

Edit one or more published post targets

Creates an independent durable provider mutation for each explicit target. Partial success is retained. X edits replace the provider Post ID.

POST
/v1/posts/{post_id}/edits

Authorization

Bearer
AuthorizationBearer <token>

API key (rlay_live_* or rlay_test_). Invite redemption also accepts a server-derived rlay_session_ bearer for a current user session.

In: header

Path Parameters

post_id*string

Relay post ID

Match^[A-Za-z0-9_-]+$
Length1 <= length <= 128

Header Parameters

idempotency-key*string

Caller-generated key for one logical provider mutation. Reusing it with a different request is rejected.

Length1 <= length <= 255

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/v1/posts/string/edits" \  -H "idempotency-key: string" \  -H "Content-Type: application/json" \  -d '{    "targets": [      {        "content": "string",        "target_id": "string"      }    ]  }'
{  "completed": 0,  "data": [    {      "account_id": "string",      "completed_at": "2019-08-24T14:15:22Z",      "created_at": "2019-08-24T14:15:22Z",      "error": "string",      "id": "string",      "kind": "string",      "platform": "string",      "provider_operation_id": "string",      "provider_post_id": "string",      "result": {        "property1": null,        "property2": null      },      "status": "pending",      "target_id": "string",      "updated_at": "2019-08-24T14:15:22Z"    }  ],  "failed": 0,  "partial": true,  "unknown": 0}

Found something wrong? Help us improve this page.

Report an issueEdit this page on GitHub

Create a post POST

Create a post. Use scheduled_at: "now" to publish immediately, "draft" to save as draft, or an ISO timestamp to schedule.

Delete a post DELETE

Delete a post.