zappzy Support Center > Developer > API Reference: Explore available endpoints and functions

API Reference: Explore available endpoints and functions

The API Reference is intended for developers, so we assume a basic level of experience.

That’s why this article is text-based — no images, no video walkthrough.

Use your token

To authenticate, add an Authorization header to your HTTP requests.


The format is: Authorization: Bearer <your-token>.

Replace <your-token> with the access token you generated earlier.


The base URL for all zappzy API endpoints is:


https://www.zappzy.com/app/api/*

* stands for your workspaceUuid. If you’re the workspace owner or an admin, you’ll find it under Settings (Usage in API).


If you’re a member, you won’t see the workspaceUuid. Ask your workspace owner or an admin to share the workspaceUuid with you.


Example:


curl -L -X GET 'https://www.zappzy.com/app/api/3hdfg0951-5b46-832b-b2z1-688588b0720e/accounts' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <token>'

List accounts

Get an account

List media files

Get a media file

Update a media file

Upload a media file

Delete a media file

List tags

Get a tag

Create a tag

Update a tag

Delete a tag

List posts

Get a post

Create a post

Update a post

Delete a post

Delete multiple post

Schedule a post

Add a post to Queue

Approve a post

List accounts

This endpoint retrieves all social media accounts connected to your zappzy workspace.

Method: GET

URL: https://www.zappzy.com/app/api/<workspaceUuid>/accounts

Method: Bearer <token>

Response:



{
  "data": [
    {
      "id": 6,
      "uuid": "123e1111-e89b-12d3-a111-426614171111",
      "name": "YourName",
      "username": "xxXXx",
      "image": "https://www.zappzy.com/avatar/youravatar.jpg",
      "provider": "instagram",
      "data": {},
      "authorized": true,
      "created_at": "2025-03-30 10:00:00"
    },
    {
      "id": 5,
      "uuid": "456e1111-e89b-12d3-a111-426614171111",
      "name": "YourName",
      "username": "xxXXx",
      "image": "https://www.zappzy.com/avatar/youravatar.jpg",
      "provider": "tiktok",
      "data": {
        "union_id": "12354564",
        "is_private": false,
        "duet_disabled": false,
        "privacy_levels": [
          "PUBLIC_TO_EVERYONE",
          "MUTUAL_FOLLOW_FRIENDS",
          "SELF_ONLY"
        ],
        "stitch_disabled": false,
        "comment_disabled": false,
        "max_video_post_duration_sec": 600
      },
      "authorized": true,
      "created_at": "2025-03-29 14:47:32"
    },
    {
      "id": 4,
      "uuid": "789e1111-e89b-12d3-a111-426614171111",
      "name": "YourName",
      "username": "xxXXx",
      "image": "https://www.zappzy.com/avatar/youravatar.jpg",
      "provider": "pinterest",
      "data": {
        "relationships": {
          "boards": [
            {
              "id": "123378040495433160",
              "name": "Local"
            }
          ]
        }
      },
      "authorized": true,
      "created_at": "2025-03-29 14:42:37"
    },
    {
      "id": 3,
      "uuid": "012e1111-e89b-12d3-a111-426614171111",
      "name": "YourName",
      "username": "xxXXx",
      "image": "https://www.zappzy.com/avatar/youravatar.jpg",
      "provider": "twitter",
      "data": null,
      "authorized": true,
      "created_at": "2025-03-29 09:55:31"
    },
    {
      "id": 2,
      "uuid": "345e1111-e89b-12d3-a111-426614171111",
      "name": "YourName",
      "username": "xxXXx",
      "image": null,
      "provider": "linkedin",
      "data": null,
      "authorized": true,
      "created_at": "2025-03-29 09:49:22"
    },
    {
      "id": 1,
      "uuid": "678e1111-e89b-12d3-a111-426614171111",
      "name": "YourName",
      "username": "xxXXx",
      "image": "https://www.zappzy.com/avatar/youravatar.jpg",
      "provider": "facebook_page",
      "data": {
        "suffix": {
          "value": "Page",
          "edited": false
        }
      },
      "authorized": true,
      "created_at": "2025-03-27 11:30:45"
    }
  ]
}


{
  "message": "Unauthenticated."
}


{
  "message": "Access forbidden."
}


{
  "message": "Workspace not found."
}

Get an account

This endpoint retrieves details for a specific social media account in your zappzy workspace.

Method: GET

URL: https://www.zappzy.com/app/api/<workspaceUuid>/accounts/<accountUuidd>

Method: Bearer <token>

Response:



{
  "id": 1,
  "uuid": "123e1111-e89b-12d3-a111-426614171111",
  "name": "YourName",
  "username": "xxXXx",
  "image": "https://www.zappzy.com/avatar/youravatar.jpg",
  "provider": "facebook_page",
  "data": {
    "suffix": {
      "value": "Page",
      "edited": false,
    }
  },
  "authorized": true,
  "created_at": "2024-03-27 11:30:45"
}


{
  "message": "Unauthenticated."
}


{
  "message": "Access forbidden."
}


{
  "message": "Workspace not found."
}
OR
{
  "message": "Account not found."
}

List media files

This endpoint retrieves all media files (images and videos) from your zappzy media library.

Method: GET

URL: https://www.zappzy.com/app/api/<workspaceUuid>/media?page=1

Method: Bearer <token>

Response:



{
  "data": [
    {
      "id": "2",
      "uuid": "123e1111-e89b-12d3-a111-426614171111",
      "name": "test-reduced-file-size.mp4",
      "mime_type": "video/mp4",
      "type": "video",
      "url": "https://www.zappzy.com/storage/456e1111-e89b-12d3-a111-426614171111/uploads/03-2025/1233AR2JF6MHl79rG7qWxGdEiqzneaOxMcnuw1M7.mp4",
      "thumb_url": "https://www.zappzy.com/storage/456e1111-e89b-12d3-a111-426614171111/uploads/03-2025/1233AR2JF6MHl79rG7qWxGdEiqzneaOxMcnuw1M7-thumb.jpg",
      "is_video": true,
      "created_at": "2025-03-29 15:33:32"
    },
    {
      "id": "1",
      "uuid": "123e1111-e89b-12d3-a111-426614171111",
      "name": "test.png",
      "mime_type": "image/png",
      "type": "image",
      "url": "https://www.zappzy.com/storage/456e1111-e89b-12d3-a111-426614171111/uploads/03-2025/123EvFqHQYEU14DARrqULDnvoh7GMYopQGqYGhoi.png",
      "thumb_url": "https://www.zappzy.com/storage/456e1111-e89b-12d3-a111-426614171111/uploads/03-2025/123EvFqHQYEU14DARrqULDnvoh7GMYopQGqYGhoi-thumb.png",
      "is_video": false,
      "created_at": "2024-03-29 15:33:23"
    }
  ],
  "links": {
    "first": "https://www.zappzy.com/app/api/456e1111-e89b-12d3-a111-426614171111/media?page=1",
    "last": "https://www.zappzy.com/app/api/456e1111-e89b-12d3-a111-426614171111/media?page=1",
    "prev": null,
    "next": null
  },
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 1,
    "links": [
      {
        "url": null,
        "label": "« Previous",
        "active": false
      },
      {
        "url": "https://www.zappzy.com/app/api/456e1111-e89b-12d3-a111-426614171111/media?page=1",
        "label": "1",
        "active": true
      },
      {
        "url": null,
        "label": "Next »",
        "active": false
      }
    ],
    "path": "https://www.zappzy.com/app/api/456e1111-e89b-12d3-a111-426614171111/media",
    "per_page": 20,
    "to": 2,
    "total": 2
  }
}


{
  "message": "Unauthenticated."
}


{
  "message": "Access forbidden."
}


{
  "message": "Workspace not found."
}

Get a media file

This endpoint retrieves details for a specific media file from your zappzy media library.

Method: GET

URL: https://www.zappzy.com/app/api/<workspaceUuid>/media/<mediaUuid>

Method: Bearer <token>

Response:



{
  "id": "1",
  "uuid": "123e1111-e89b-12d3-a111-426614171111",
  "name": "test.png",
  "mime_type": "image/png",
  "type": "image",
  "url": "https://www.zappzy.com/storage/456e1111-e89b-12d3-a111-426614171111/uploads/03-2025/123EvFqHQYEU14DARrqULDnvoh7GMYopQGqYGhoi.png",
  "thumb_url": "https://www.zappzy.com/storage/456e1111-e89b-12d3-a111-426614171111/uploads/03-2025/123EvFqHQYEU14DARrqULDnvoh7GMYopQGqYGhoi-thumb.png",
  "is_video": false,
  "created_at": "2025-03-29 15:33:23"
}


{
  "message": "Unauthenticated."
}


{
  "message": "Access forbidden."
}


{
  "message": "Workspace not found."
}
OR
{
  "message": "Media not found."
}

Update a media file

This endpoint updates details for a specific media file in your zappzy media library.

Method: PUT

URL: https://www.zappzy.com/app/api/<workspaceUuid>/media/<mediaUuid>

Method: Bearer <token>

Body:


{
  "alt_text": "example-alt-text"
}


Key

Format

Required

Description

alt_text

string

Alt Text.

Response:



{
  "success": true
}


{
  "message": "Unauthenticated."
}


{
  "message": "Access forbidden."
}


{
  "message": "Workspace not found."
}
OR
{
  "message": "Media not found."
}

Upload a media file

This endpoint uploads a new media file to your zappzy media library.

Method: POST

URL: https://www.zappzy.com/app/api/<workspaceUuid>/media

Method: Bearer <token>

Body:


{
  "file": binary,
}


Key

Format

Required

Description

file

binary

required

File binary.

Response:



{
  "id": "1",
  "uuid": "123e1111-e89b-12d3-a111-426614171111",
  "name": "test.png",
  "mime_type": "image/png",
  "type": "image",
  "url": "https://www.zappzy.com/storage/456e1111-e89b-12d3-a111-426614171111/uploads/03-2025/123EvFqHQYEU14DARrqULDnvoh7GMYopQGqYGhoi.png",
  "thumb_url": "https://www.zappzy.com/storage/456e1111-e89b-12d3-a111-426614171111/uploads/03-2025/123EvFqHQYEU14DARrqULDnvoh7GMYopQGqYGhoi-thumb.png",
  "is_video": false,
  "alt_text": "This is a alt text",
  "created_at": "2025-03-29 15:33:23"
}


{
  "message": "Unauthenticated."
}


{
  "message": "Access forbidden."
}


{
  "message": "Workspace not found."
}


{
  "message": "Validation errors",
  "errors": {}
}

Delete a media file

This endpoint deletes a specific media file from your zappzy media library.

Method: DELETE

URL: https://www.zappzy.com/app/api/<workspaceUuid>/media

Method: Bearer <token>

Params:


{
  "items": [1,2]
}


Key

Format

Required

Description

items

array

required

Array of media file IDs

items.*

integer

required

Media File ID

Response:



{
  "success": true
}


{
  "message": "Unauthenticated."
}


{
  "message": "Access forbidden."
}


{
  "message": "Workspace not found."
}


{
  "message": "Validation errors",
  "errors": {}
}

List tags

This endpoint retrieves all tags from your zappzy workspace.

Method: GET

URL: https://www.zappzy.com/app/api/<workspaceUuid>/tags

Method: Bearer <token>

Response:



{
  "data": [
    {
      "id": 3,
      "uuid": "123e1111-e89b-12d3-a111-426614171111",
      "name": "news",
       "hex_color": "#38bdf8"
    },
    {
      "id": 2,
      "uuid": "123e1111-e89b-12d3-a111-426614171111",
      "name": "release",
      "hex_color": "#111827"
    },
    {
      "id": 1,
      "uuid": "123e1111-e89b-12d3-a111-426614171111",
      "name": "marketing",
      "hex_color": "#60a5fa"
    }
  ]


{
  "message": "Unauthenticated."
}


{
  "message": "Access forbidden."
}


{
  "message": "Workspace not found."
}

Get a tag

This endpoint retrieves details for a specific tag from your zappzy workspace.

Method: GET

URL: https://www.zappzy.com/app/api/<workspaceUuid>/tags/<tagUuid>

Method: Bearer <token>

Response:



{
  "id": 1,
  "uuid": "123e1111-e89b-12d3-a111-426614171111",
  "name": "marketing",
  "hex_color": "#60a5fa"
}


{
  "message": "Unauthenticated."
}


{
  "message": "Access forbidden."
}


{
  "message": "Workspace not found."
}
OR
{
  "message": "Tag not found."
}

Create a tag

This endpoint creates a new tag in your zappzy workspace.

Method: POST

URL: https://www.zappzy.com/app/api/<workspaceUuid>/tags

Method: Bearer <token>

Body:


{
  "name": "jobs",
  "hex_color": "#000000"
}


Key

Format

Required

Description

name

string

required

hex_color

string

required

HEX color

Response:



{
  "id": 4,
  "uuid": "123e1111-e89b-12d3-a111-426614171111",
  "name": "jobs",
  "hex_color": "#000000"
}


{
  "message": "Unauthenticated."
}


{
  "message": "Access forbidden."
}


{
  "message": "Workspace not found."
}


{
  "message": "Validation errors",
  "errors": {}
}

Update a tag

This endpoint updates details for a specific tag in your zappzy workspace.

Method: PUT

URL: https://www.zappzy.com/app/api/<workspaceUuid>/tags/{tagUuid}

Method: Bearer <token>

Body:


{
  "name": "jobs",
  "hex_color": "#60a5fa"
}


Key

Format

Required

Description

name

string

required

hex_color

string

required

HEX color

Response:



{
  "success": true,
}


{
  "message": "Unauthenticated."
}


{
  "message": "Access forbidden."
}


{
  "message": "Workspace not found."
}
OR
{
  "message": "Tag not found."
}


{
  "message": "Validation errors",
  "errors": {}
}

Delete a tag

This endpoint deletes a specific tag from your zappzy workspace.

Method: DELETE

URL: https://www.zappzy.com/app/api/<workspaceUuid>/tags/{tagUuid}

Method: Bearer <token>

Response:



{
  "success": true
}
OR
{
  "success": false
}


{
  "message": "Unauthenticated."
}


{
  "message": "Access forbidden."
}


{
  "message": "Workspace not found."
}

List posts

This endpoint retrieves all posts from your zappzy workspace.

Method: GET

URL: https://www.zappzy.com/app/api/<workspaceUuid>/posts?page=1

Method: Bearer <token>

Response:



{
  "data": [
    {
      "id": 3,
      "uuid": "123e1111-e89b-12d3-a111-426614171111",
      "status": "draft",
      "accounts": [],
      "versions": [
        {
          "account_id": 0,
          "is_original": true,
          "content": [
            {
              "body": "",
              "media": [],
              "url": ""
            }
          ],
          "options": {
            "tiktok": {
              "privacy_level": {
                "account-0": null
              },
              "allow_comments": {
                "account-0": false
              },
              "allow_duet": {,
                "account-0": false
              },
              "allow_stitch": {
                "account-0": false
              },
              "content_disclosure": {
                "account-0": false
              },
              "brand_organic_toggle": {/code>
                "account-0": false
              },
              "brand_content_toggle": {
                "account-0": false
              }
            },
            "youtube": {
              "title": null,
              "status": "public"
            },
            "linkedin": {
              "visibility": "PUBLIC"
            },
            "mastodon": {
              "sensitive": false
            },
            "instagram": {
              "type": "post"
            },
            "pinterest": {
              "title": null,
              "link": null,
              "boards": {
                "account-0": null
              }
            },
            "facebook_page": {
              "type": "post"
            }
          }
        }
      ],
      "tags": [
        {
          "id": 2,
          "uuid": "123e1111-e89b-12d3-a111-426614171111",
          "name": "release",
          "hex_color": "#111827"
        },
        {
          "id": 3,
          "uuid": "123e1111-e89b-12d3-a111-426614171111",
          "name": "news",
          "hex_color": "#38bdf8"
        }
      ],
      "user": {
        "name": "Test User"
      },
      "scheduled_at": null,
      "published_at": null,
      "created_at": "2025-03-29 15:26:06",
      "trashed": false
    },
    {
      "id": 2,
      "uuid": 123e1111-e89b-12d3-a111-426614171111",
      "status": "published",
      "accounts": [
        {
          "id": 3,
          "uuid": "123e1111-e89b-12d3-a111-426614171111",
          "name": "YourName",
          "username": "xxXXx",
          "image": "https://www.zappzy.com/avatar/youravatar.jpg",
          "provider": "twitter",
          "data": null,
          "authorized": true,
          "created_at": "2025-03-29 09:55:31",
          "external_url": "https://twitter.com/xxXXx/status/12324241115453465",
          "errors": []
        }
      ],
      "versions": [
        {
          "account_id": 0,
          "is_original": true,
          "content": [
            {
              "body": "<div>This is a test post 💻✨</div>",
              "media": [
                {
                  "id": "1",
                  "name": "test.png",
                  "mime_type": "image/png",
                  "type": "image",
                  "url": "https://www.zappzy.com/storage/456e1111-e89b-12d3-a111-426614171111/uploads/03-2025/123EvFqHQYEU14DARrqULDnvoh7GMYopQGqYGhoi.png",
                  "thumb_url": "https://www.zappzy.com/storage/456e1111-e89b-12d3-a111-426614171111/uploads/03-2025/123EvFqHQYEU14DARrqULDnvoh7GMYopQGqYGhoi-thumb.png",
                  "is_video": false,
                  "created_at": "2025-03-29 15:33:23"
                }
              ],
              "url": ""
            }
          ],
          "options": {
            "tiktok": {
              "privacy_level": {
                "account-0": null
              },
              "allow_comments": {
                "account-0": false
              },
              "allow_duet": {,
                "account-0": false
              },
              "allow_stitch": {
                "account-0": false
              },
              "content_disclosure": {
                "account-0": false
              },
              "brand_organic_toggle": {/code>
                "account-0": false
              },
              "brand_content_toggle": {
                "account-0": false
              }
            },
            "youtube": {
              "title": null,
              "status": "public"
            },
            "linkedin": {
              "visibility": "PUBLIC"
            },
            "mastodon": {
              "sensitive": false
            },
            "instagram": {
              "type": "post"
            },
            "pinterest": {
              "title": null,
              "link": null,
              "boards": {
                "account-0": null
              }
            },
            "facebook_page": {
              "type": "post"
            }
          }
        }
      ],
      "tags": [],
      "user": {
        "name": "YourName"
      },
      "scheduled_at": "2025-03-29 09:55:57",
      "published_at": "2025-03-29 09:56:03",
      "created_at": "2025-03-29 09:55:34",
      "trashed": false
    },
    {
      "id": 1,
      "uuid": "123e1111-e89b-12d3-a111-426614171111",
      "status": "published",
      "accounts": [
        {
          "id": 2,
          "name": "YourName",
          "username": "xxXXx",
          "image": null,
          "provider": "linkedin",
          "data": null,
          "authorized": true,
          "created_at": "2025-03-29 09:49:22",
          "external_url": "https://linkedin.com/feed/update/urn:li:share:12336647554322",
          "errors": []
        },
        {
          "id": 1,
          "uuid": "123e1111-e89b-12d3-a111-426614171111",
          "name": "YourName",
          "username": "xxXXx",
          "image": "https://www.zappzy.com/avatar/youravatar.jpg",
          "provider": "facebook_page",
          "data": {
            "suffix": {
              "value": "Page",
              "edited": false
            }
          },
          "authorized": true,
          "created_at": "2025-03-27 11:30:45",
          "external_url": "https://facebook.com/1232042343434323/1239414779038416896",
          "errors": []
        }
      ],
      "versions": [
        {
          "account_id": 0,
          "is_original": true,
          "content": [
            {
              "body": "<div>This is a test post.</div>",
              "media": [
                {
                  "id": "2",
                  "name": "test-reduced-file-size.mp4",
                  "mime_type": "video/mp4",
                  "type": "video",
                  "url": "https://www.zappzy.com/storage/456e1111-e89b-12d3-a111-426614171111/uploads/03-2025/1233AR2JF6MHl79rG7qWxGdEiqzneaOxMcnuw1M7.mp4",
                  "thumb_url": "https://www.zappzy.com/storage/456e1111-e89b-12d3-a111-426614171111/uploads/03-2025/1233AR2JF6MHl79rG7qWxGdEiqzneaOxMcnuw1M7-thumb.jpg",
                  "is_video": true,
                  "created_at": "2025-03-29 15:33:32"
                }
              ],
              "url": ""
            }
          ],
          "options": {
            "tiktok": {
              "privacy_level": {
                "account-0": null
              },
              "allow_comments": {
                "account-0": false
              },
              "allow_duet": {,
                "account-0": false
              },
              "allow_stitch": {
                "account-0": false
              },
              "content_disclosure": {
                "account-0": false
              },
              "brand_organic_toggle": {/code>
                "account-0": false
              },
              "brand_content_toggle": {
                "account-0": false
              }
            },
            "youtube": {
              "title": null,
              "status": "public"
            },
            "linkedin": {
              "visibility": "PUBLIC"
            },
            "mastodon": {
              "sensitive": false
            },
            "instagram": {
              "type": "post"
            },
            "pinterest": {
              "title": null,
              "link": null,
              "boards": {
                "account-0": null
              }
            },
            "facebook_page": {
              "type": "post"
            }
          }
        }
      ],
      "tags": [
        {
          "id": 1,
          "uuid": "123e1111-e89b-12d3-a111-426614171111",
          "name": "jobs",
          "hex_color": "#60a5fa"
        }
      ],
      "user": {
        "name": "YourName"
      },
      "scheduled_at": "2025-03-29 09:50:56",
      "published_at": "2025-03-29 09:51:10",
      "created_at": "2025-03-29 09:50:46",
      "trashed": false
    }
  ],
  "links": {
    "first": "https://www.zappzy.com/api/api/123e1111-e89b-12d3-a111-426614171111/posts?page=1",
    "last": "https://www.zappzy.com/api/api/123e1111-e89b-12d3-a111-426614171111/posts?page=1",
    "prev": null,
    "next": null
  },
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 1
    "links": [
      {
        "url": null,
        "label": "« Previous",
        "active": false
      },
      {
        "url": "https://www.zappzy.com/api/api/123e1111-e89b-12d3-a111-426614171111/posts?page=1",
        "label": "1",
        "active": true
      },
      {
        "url": null,
        "label": "Next »"
        "active": false
      }
    ],
    "path": "https://www.zappzy.com/api/api/123e1111-e89b-12d3-a111-426614171111/posts",
    "per_page": 20,
    "to": 3,
    "total": 3
  }
}


{
  "message": "Unauthenticated."
}


{
  "message": "Access forbidden."
}


{
  "message": "Workspace not found."
}

Get a post

This endpoint retrieves details for a specific post from your zappzy workspace.

Method: GET

URL: https://www.zappzy.com/app/api/<workspaceUuid>/posts/<postUuid>

Method: Bearer <token>

Response:



{
  "id": 1,
  "uuid": "123e1111-e89b-12d3-a111-426614171111",
  "status": "published",
  "accounts": [
    {
      "id": 2,
      "uuid": "123e1111-e89b-12d3-a111-426614171111",
      "name": "YourName",
      "username": "xxXXx",
      "image": null,
      "provider": "linkedin",
      "data": null,
      "authorized": true,
      "created_at": "2025-03-29 09:49:22",
      "external_url": "https://linkedin.com/feed/update/urn:li:share:12336647554322",
      "errors": []
    },
    {
      "id": 1,
      "uuid": "123e1111-e89b-12d3-a111-426614171111",
      "name": "YourName",
      "username": "xxXXx",
      "image": "https://www.zappzy.com/avatar/youravatar.jpg",
      "provider": "facebook_page",
      "data": {
        "suffix": {
          "value": "Page",
          "edited": false
        }
      },
      "authorized": true,
      "created_at": "2025-03-27 11:30:45",
      "external_url": "https://facebook.com/1232042343434323/1239414779038416896",
      "errors": []
   }
  ],
  "versions": [
    {
      "account_id": 0,
      "is_original": true,
      "content": [
        {
          "body": "<div>This is a test post 💻✨</div>",
          "media": [
            {
              "id": "1",
              "name": "test.png",
              "mime_type": "image/png",
              "type": "image",
              "url": "https://www.zappzy.com/storage/456e1111-e89b-12d3-a111-426614171111/uploads/03-2025/123EvFqHQYEU14DARrqULDnvoh7GMYopQGqYGhoi.png",
              "thumb_url": "https://www.zappzy.com/storage/456e1111-e89b-12d3-a111-426614171111/uploads/03-2025/123EvFqHQYEU14DARrqULDnvoh7GMYopQGqYGhoi-thumb.png",
              "is_video": false,
              "created_at": "2025-03-29 15:33:23"
            }
          ],
          "url": ""
        }
      ],
      "options": {
        "tiktok": {
          "privacy_level": {
            "account-0": null
          },
          "allow_comments": {
            "account-0": false
          },
          "allow_duet": {,
            "account-0": false
          },
          "allow_stitch": {
            "account-0": false
          },
          "content_disclosure": {
            "account-0": false
          },
          "brand_organic_toggle": {
            "account-0": false
          },
          "brand_content_toggle": {
            "account-0": false
          }
        },
        "youtube": {
          "title": null,
          "status": "public"
        },
        "linkedin": {
          "visibility": "PUBLIC"
        },
        "mastodon": {
          "sensitive": false
        },
        "instagram": {
          "type": "post"
        },
        "pinterest": {
          "title": null,
          "link": null,
          "boards": {
            "account-0": null
          }
        },
        "facebook_page": {
          "type": "post"
        }
      }
    }
  ],
  "tags": [
    {
      "id": 1,
      "uuid": "123e1111-e89b-12d3-a111-426614171111",
      "name": "jobs",
      "hex_color": "#60a5fa"
    }
  ],
  "user": {
    "name": "YourName"
  },
  "scheduled_at": "2025-03-29 09:50:56",
  "published_at": "2025-03-29 09:51:10",
  "created_at": "2025-03-29 09:50:46",
  "trashed": false
}


{
  "message": "Unauthenticated."
}


{
  "message": "Access forbidden."
}


{
  "message": "Workspace not found."
}
OR
{
  "message": "Post not found."
}

Create a post

This endpoint creates a new post in your zappzy workspace.

Method: POST

URL: https://www.zappzy.com/app/api/<workspaceUuid>/posts

Method: Bearer <token>

Body:


{
  "date": "2025-05-23",
  "time": "10:00",
  "timezone": "Europe/Zurich",
  "schedule": true,
  "schedule_now": true
  "queue": true,
  "accounts": [1,2,3],
  "tags": [1,2],
  "versions": [
    {
      "account_id": 0,
      "is_original": true,
      "content": [
        {
          "body": "This is the content",
          "media": [
            1
          ]
        }
      ],
      "options": {
        "mastodon": {
          "sensitive": false
        }
      }
    }
  ]
}


Key

Format

Required

Description

date

Y-m-d

time

H:i

timezone

Europe/Zurich

Specify your preferred time zone when necessary. In its absence, zappzy will default to the timezone set for your account.

schedule

boolean

Set to true to schedule the post. Set to false to create the post without scheduling.

schedule_now

boolean

queue

boolean

Set to true to add the post to the queue.

accounts

array

Array of account IDs

accounts.*

integer

required

Account ID

tags

array

Array of tag IDs

tags.*

integer

required

Tag ID

versions

array

required

Array of version objects

versions.*.account_id

integer

required

Specify the account for which the version is available. For the original version, use the value 0.

versions.*.is_original

boolean

required

The first version is always set to true.

versions.*.content

array

required

Array of content objects

versions.*.content.*.body

null

string

versions.*.content.*.url

null

string

versions.*.content.*.media

array

Array of media IDs

versions.*.content.*.media.*

integer

required

Media ID

versions.*.content.*.video_thumbs

array

Array of media relationship objects for video ID and its thumbnail ID

versions.*.content.*.video_thumbs.*

object

Media relationship object for video ID and its thumbnail ID

versions.*.content.*.video_thumbs.*.media_id

integer

Existing video media ID (only supported video mime types)

versions.*.content.*.video_thumbs.*.thumb_id

integer

Existing image media ID (only supported image mime types)

versions.*.options

object

Options available for each social service provider:


{
  "facebook_page": {
    "type": "post" // post,reel,story
  },
  "instagram": {
    "type": "post" // post,reel,story
  },
  "linkedin": {
    "visibility": "PUBLIC" // PUBLIC,CONNECTIONS
  },
  "mastodon": {
    "sensitive": false // boolean
  },
  "pinterest": {
    "link": null, // null|string
    "title": "", // string
    "boards": {
      "account-1": "123672010430333260" // string | The key `account-*` is the ID of your Pinterest account
    }
  },
  "youtube": {
    "title": null', // null|string
    "status": "public" // public,private,unlisted
  },
  "tiktok": {
    "privacy_level": {
      "account-2": 'PUBLIC_TO_EVERYONE' // string | PUBLIC_TO_EVERYONE,MUTUAL_FOLLOW_FRIENDS,SELF_ONLY | The key `account-*` is the ID of your TikTok account.
    },
    "allow_comments": {
      "account-2": true // boolean | The key `account-*` is the ID of your TikTok account
    },
    "allow_duet": {
      "account-2": false // boolean | The key `account-*` is the ID of your TikTok account
    },
    "allow_stitch": {
      "account-2": false // boolean | The key `account-*` is the ID of your TikTok account
    },
    "content_disclosure": {
       "account-2": false // boolean | The key `account-*` is the ID of your TikTok account
    },
    "brand_organic_toggle": {
      "account-2": false // boolean | The key `account-*` is the ID of your TikTok account
    },
    "brand_content_toggle": {
      "account-2": false // boolean | The key `account-*` is the ID of your TikTok account
    },
  }
}

Response:



{
  "id": 3,
  "uuid": "123e1111-e89b-12d3-a111-426614171111",
  "name": "jobs",
  "hex_color": "#000000"
}


{
  "message": "Unauthenticated."
}


{
  "message": "Access forbidden."
}


{
  "message": "Workspace not found."
}


{
  "message": "Validation errors",
  "errors": {}
}

Update a post

This endpoint updates details for a specific post in your zappzy workspace.

Method: PUT

URL: https://www.zappzy.com/app/api/<workspaceUuid>/posts/{postUuid}

Method: Bearer <token>

Body:


{
  "date": "2025-05-23",
  "time": "10:00",
  "timezone": "Europe/Zurich",
  "accounts": [1,2,3],
  "tags": [1,2],
  "versions": [
    {
      "account_id": 0,
      "is_original": true,
      "content": [
        {
          "body": "This is the content v2",
          "media": [1]
        }
      ],
      "options": {
        "mastodon": {
          "sensitive": false
        }
      }
    }
  ]
}


Response:



{
  "success": true,
}


{
  "message": "Unauthenticated."
}


{
  "message": "Access forbidden."
}


{
  "message": "Workspace not found."
}
OR
{
  "message": "Post not found."
}


{
  "message": "Validation errors",
  "errors": {}
}

Delete a post

This endpoint deletes a specific post from your zappzy workspace.

Method: DELETE

URL: https://www.zappzy.com/app/api/<workspaceUuid>/posts/{postUuid}

Method: Bearer <token>

Body:


{
  "trash": false
}


Key

Format

Required

Description

trash

boolean

Set true to move the item to trash; set false to delete it permanently. Default: false.

Response:



{
  "deleted": true
}
OR
{
  "to_trash": true
}


{
  "message": "Unauthenticated."
}


{
  "message": "Access forbidden."
}


{
  "message": "Workspace not found."
}

Delete multiple post

This endpoint deletes multiple posts from your zappzy workspace.

Method: DELETE

URL: https://www.zappzy.com/app/api/<workspaceUuid>/posts

Method: Bearer <token>

Body:


{
 "posts": ['8eb4e98d-2b93-44bd-a664-7a6438eff67b', 'b1b06706-ef95-42b7-8ac8-d648dc9a9d65'],
  "trash": false
}


Key

Format

Required

Description

posts

array

required

Array of posts Uuids

posts.*

string

required

Post Uuid

trash

boolean

Set true to move the item to trash; set false to delete it permanently. Default: false.

Response:



{
  "deleted": true
}
OR
{
  "to_trash": true
}


{
  "message": "Unauthenticated."
}


{
  "message": "Access forbidden."
}


{
  "message": "Workspace not found."
}


{
  "message": "Validation errors",
  "errors": {}
}

Schedule a post

This endpoint schedules a post for publishing in your zappzy workspace.

Method: POST

URL: https://www.zappzy.com/app/api/<workspaceUuid>/posts/schedule/{postUuid}

Method: Bearer <token>

Body:


{
  "postNow": true
}


Key

Format

Required

Description

postNow

boolean

required

Set to true to schedule the post now. Set to false to schedule the post at the set post time.

Response:



{
  "success": true,
  "scheduled_at": "2025-05-02 08:49:15",
}


{
  "message": "Unauthenticated."
}


{
  "message": "Access forbidden."
}


{
  "message": "Workspace not found."
}
OR
{
    "message": "Post not found."
}


{
  "message": "Validation errors",
  "errors": {}
}

Add a post to Queue

This endpoint adds a post to your zappzy publishing queue.

Method: POST

URL: https://www.zappzy.com/app/api/<workspaceUuid>/posts/add-to-queue/{postUuid}

Method: Bearer <token>

Response:



{
  "success": true,
  "scheduled_at": "2025-05-02 08:49:15",
}


{
  "message": "Unauthenticated."
}


{
  "message": "Access forbidden."
}


{
  "message": "Workspace not found."
}
OR
{
    "message": "Post not found."
}


{
  "message": "Validation errors",
  "errors": {}
}

Approve a post

This endpoint approves a post for publishing in your zappzy workspace.

Method: POST

URL: https://www.zappzy.com/app/api/<workspaceUuid>/posts/approve/{postUuid}

Method: Bearer <token>

Response:



{
  "success": true,
  "scheduled_at": "2025-05-02 08:49:15",
}


{
  "message": "Unauthenticated."
}


{
  "message": "Access forbidden."
}


{
  "message": "Workspace not found."
}
OR
{
    "message": "Post not found."
}


{
  "message": "Validation errors",
  "errors": {}
}