beehiiv Developer Documentation

{
  "data": {
    "id": "pub_dup_00000000-0000-0000-0000-000000000000",
    "status": "partial",
    "source_publication_id": "pub_00000000-0000-0000-0000-000000000000",
    "destination_publication_id": "pub_11111111-1111-1111-1111-111111111111",
    "components": [
      "custom_fields",
      "segments"
    ],
    "results": {
      "custom_fields": {
        "status": "completed",
        "copied": 5,
        "failed": []
      },
      "segments": {
        "status": "partial",
        "copied": 3,
        "failed": [
          "Paid subscribers"
        ]
      }
    },
    "completed": 1666800099,
    "created": 1666800076,
    "updated": 1666800099
  }
}

This is a gated feature that requires enablement. Contact support to enable Publication Duplication for your workspace.

Returns a publication duplicate, including how copying each component went. Poll this after creating one until the status is completed, partial, or failed.

<Warning>This is a gated feature that requires enablement. Contact support to enable Publication Duplication for your workspace.</Warning> Returns a publication duplicate, including how copying each component went. Poll this after creating one until the status is `completed`, `partial`, or `failed`.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

publicationIdstringRequiredformat: "^(pub_[0-9a-fA-F\-]+)$"

The prefixed ID of the publication that was copied

idstringRequiredformat: "^(pub_dup_[0-9a-fA-F\-]+)$"

The prefixed ID of the publication duplicate

Response

dataobjectOptional

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

429

Too Many Requests Error

500

Internal Server Error