Update a scheduled post

curl --request PATCH \
  --url https://api.nylon.dev/v1/posts/{postId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{}'

{
  "data": {
    "id": "cly7q9v2m0001x8b3a1c4d0dd",
    "status": "published",
    "text": "<string>",
    "media": [
      {
        "url": "<string>",
        "type": "image",
        "mime_type": "image/jpeg",
        "size_bytes": 123,
        "alt": "<string>",
        "thumbnail_url": "<string>"
      }
    ],
    "post_type": "post",
    "auto_thread": true,
    "source": "api",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "targets": [
      {
        "id": "cly7q9v2m0002x8b3b5e6f0ee",
        "profile_id": "cly7p2q4k0001x8b3f2n9d0aa",
        "network": "instagram",
        "profile_name": "Nylon Studio",
        "status": "published",
        "post_ids": [
          "17924418112233445"
        ],
        "attempts": 1,
        "url": "<string>",
        "published_at": "2023-11-07T05:31:56Z",
        "error": {
          "code": "rejected_by_network",
          "message": "The caption contains a link this account is not allowed to post."
        }
      }
    ],
    "link": {
      "url": "<string>",
      "title": "<string>",
      "description": "<string>",
      "image_url": "<string>"
    },
    "title": "<string>",
    "thread": [
      "<string>"
    ],
    "networks": {},
    "scheduled_at": "2023-11-07T05:31:56Z",
    "published_at": "2023-11-07T05:31:56Z",
    "idempotency_key": "<string>"
  }
}

{
  "error": {
    "code": "invalid_request",
    "message": "The request body is not valid.",
    "details": [
      {
        "field": "profile_ids",
        "message": "Address the post to at least one profile."
      }
    ]
  }
}

{
  "error": {
    "code": "unauthorized",
    "message": "A valid Nylon API key is required."
  }
}

{
  "error": {
    "code": "not_found",
    "message": "Post could not be found."
  }
}

{
  "error": {
    "code": "unauthorized",
    "message": "A valid Nylon API key is required.",
    "details": [
      {
        "message": "Instagram requires at least 1 media item — text-only posts are not supported.",
        "field": "profile_ids",
        "network": "instagram",
        "code": "invalid_request"
      }
    ]
  }
}

{
  "error": {
    "code": "rate_limited",
    "message": "Too many requests. Retry after the window resets."
  }
}

{
  "error": {
    "code": "unauthorized",
    "message": "A valid Nylon API key is required.",
    "details": [
      {
        "message": "Instagram requires at least 1 media item — text-only posts are not supported.",
        "field": "profile_ids",
        "network": "instagram",
        "code": "invalid_request"
      }
    ]
  }
}

PATCH

https://api.nylon.dev

posts

{postId}

curl --request PATCH \
  --url https://api.nylon.dev/v1/posts/{postId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{}'

{
  "data": {
    "id": "cly7q9v2m0001x8b3a1c4d0dd",
    "status": "published",
    "text": "<string>",
    "media": [
      {
        "url": "<string>",
        "type": "image",
        "mime_type": "image/jpeg",
        "size_bytes": 123,
        "alt": "<string>",
        "thumbnail_url": "<string>"
      }
    ],
    "post_type": "post",
    "auto_thread": true,
    "source": "api",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "targets": [
      {
        "id": "cly7q9v2m0002x8b3b5e6f0ee",
        "profile_id": "cly7p2q4k0001x8b3f2n9d0aa",
        "network": "instagram",
        "profile_name": "Nylon Studio",
        "status": "published",
        "post_ids": [
          "17924418112233445"
        ],
        "attempts": 1,
        "url": "<string>",
        "published_at": "2023-11-07T05:31:56Z",
        "error": {
          "code": "rejected_by_network",
          "message": "The caption contains a link this account is not allowed to post."
        }
      }
    ],
    "link": {
      "url": "<string>",
      "title": "<string>",
      "description": "<string>",
      "image_url": "<string>"
    },
    "title": "<string>",
    "thread": [
      "<string>"
    ],
    "networks": {},
    "scheduled_at": "2023-11-07T05:31:56Z",
    "published_at": "2023-11-07T05:31:56Z",
    "idempotency_key": "<string>"
  }
}

{
  "error": {
    "code": "invalid_request",
    "message": "The request body is not valid.",
    "details": [
      {
        "field": "profile_ids",
        "message": "Address the post to at least one profile."
      }
    ]
  }
}

{
  "error": {
    "code": "unauthorized",
    "message": "A valid Nylon API key is required."
  }
}

{
  "error": {
    "code": "not_found",
    "message": "Post could not be found."
  }
}

{
  "error": {
    "code": "unauthorized",
    "message": "A valid Nylon API key is required.",
    "details": [
      {
        "message": "Instagram requires at least 1 media item — text-only posts are not supported.",
        "field": "profile_ids",
        "network": "instagram",
        "code": "invalid_request"
      }
    ]
  }
}

{
  "error": {
    "code": "rate_limited",
    "message": "Too many requests. Retry after the window resets."
  }
}

{
  "error": {
    "code": "unauthorized",
    "message": "A valid Nylon API key is required.",
    "details": [
      {
        "message": "Instagram requires at least 1 media item — text-only posts are not supported.",
        "field": "profile_ids",
        "network": "instagram",
        "code": "invalid_request"
      }
    ]
  }
}

Authorizations

Authorization

string

header

required

An API key beginning with nylon_live_.

Path Parameters

postId

string

required

The Nylon id of the post.

Example:

"cly7q9v2m0001x8b3a1c4d0dd"

Body

application/json

Every field of CreatePostRequest, all optional. Content fields are replaced rather than merged.

profile_ids

string[]

Minimum array length: 1

text

string

Maximum string length: 20000

media

(string<uri> | object)[]

Maximum array length: 35

A URL, or an object when you want alt text or a video cover.

Example:

"https://cdn.example.com/launch.jpg"

link

A URL, or an object to control the preview card.

post_type

enum<string>

Available options:

post,

reel,

story

title

string | null

Maximum string length: 300

thread

string[] | null

Maximum array length: 50

auto_thread

boolean

scheduled_at

string<date-time> | null

publish_now

boolean

networks

object

Hide child attributes

networks.{key}

object

Per-network overrides. The content keys below replace the base values for that network only; every other key is passed through to the publisher, because the option set differs per network. GET /v1/networks lists the options each one reads.

Hide child attributes

networks.{key}.text

string | null

networks.{key}.title

string | null

networks.{key}.media

(string<uri> | object)[] | null

A URL, or an object when you want alt text or a video cover.

Example:

"https://cdn.example.com/launch.jpg"

networks.{key}.thread

string[] | null

networks.{key}.post_type

enum<string> | null

Available options:

post,

reel,

story,

null

Example:

{
  "board_id": "881573081235",
  "title": "Launch day"
}

Response

The updated post.

data

object

required

Hide child attributes

data.id

string

required

Example:

"cly7q9v2m0001x8b3a1c4d0dd"

data.status

enum<string>

required

Derived from the targets. partially_published means some networks took it and some did not — retry the rest.

Available options:

draft,

scheduled,

publishing,

published,

partially_published,

failed,

cancelled

Example:

"published"

data.text

string

required

data.media

object[]

required

Hide child attributes

data.media.url

string<uri>

required

data.media.type

enum<string>

required

Resolved from the file, not from the extension.

Available options:

image,

video,

gif

data.media.mime_type

string

Example:

"image/jpeg"

data.media.size_bytes

integer | null

Null when the host refuses HEAD and sends no length.

data.media.alt

string | null

data.media.thumbnail_url

string<uri> | null

data.post_type

enum<string>

required

Available options:

post,

reel,

story

data.auto_thread

boolean

required

data.source

string

required

Where the post came from.

Example:

"api"

data.created_at

string<date-time>

required

data.updated_at

string<date-time>

required

data.targets

object[]

required

Hide child attributes

data.targets.id

string

required

Example:

"cly7q9v2m0002x8b3b5e6f0ee"

data.targets.profile_id

string

required

Example:

"cly7p2q4k0001x8b3f2n9d0aa"

data.targets.network

enum<string>

required

A network Nylon publishes to.

Available options:

facebook,

instagram,

x,

linkedin,

pinterest,

bluesky,

threads,

tiktok,

youtube,

google_business,

mastodon,

discord

Example:

"instagram"

data.targets.profile_name

string

required

The profile's name as it was when the post was created.

Example:

"Nylon Studio"

data.targets.status

enum<string>

required

Available options:

pending,

publishing,

published,

failed,

skipped

Example:

"published"

data.targets.post_ids

string[]

required

The network's own ids for what was published. More than one when the post was threaded.

Example:

["17924418112233445"]

data.targets.attempts

integer

required

How many times publishing this target has been attempted.

Example:

1

data.targets.url

string<uri> | null

Permalink to the published post, where the network returns one.

data.targets.published_at

string<date-time> | null

data.targets.error

object | null

Why this target failed. Null while pending or once published.

Hide child attributes

data.targets.error.code

string

Example:

"rejected_by_network"

data.targets.error.message

string

Example:

"The caption contains a link this account is not allowed to post."

data.link

object | null

Hide child attributes

data.link.url

string<uri>

required

data.link.title

string | null

data.link.description

string | null

data.link.image_url

string<uri> | null

data.title

string | null

data.thread

string[] | null

data.networks

object

The per-network overrides this post was created with.

data.scheduled_at

string<date-time> | null

data.published_at

string<date-time> | null

data.idempotency_key

string | null

Overview

Endpoints

Authorizations

Path Parameters

Body

Response