Campaigns

/campaigns

Changed on

Creates a campaign to group posts under.

Make one before planning a batch, then pass its id as campaign_id on each POST /posts — that is what makes a month of posts one thing the customer can see and manage in ProductByte, rather than a pile of unassigned posts.

Requires the posts:write scope.

post/projects/{project_id}/campaigns

Request

  • Base URL: https://api.productbyte.com/v1
  • URL: https://api.productbyte.com/v1/projects/{project_id}/campaigns
  • Auth: HTTP bearer

Path parameters

project_idstring required

The project to create the campaign in.

Request body

namestring required

What to call it. Shown to the customer in ProductByte.

start_datestring date

The day the campaign starts, as YYYY-MM-DD. Presentational only.

Response

The campaign.

idstring required

Pass this as campaign_id when creating a post.

namestring required

The campaign’s name.

start_datestring date-time

When the campaign starts, when a start day is set. Normalized to midnight UTC on that day — it is a date the product shows, not a scheduling instruction.

post_countinteger required

How many posts belong to it.

created_atstring date-time required

When the campaign was created.

updated_atstring date-time required

When it last changed.

Changes

  • e44332d6b9c6Revision changes
    • warning

      removed the request property

    • warning

      removed the optional property from the response with the status