ENendless
admin
campaigns

Create Campaign

Create a campaign in one call: creates the underlying Organization row (organization_type=CAMPAIGN) and its CampaignDetails extension, then commits both together.

post/api/v3/admin/campaigns/

Request

  • Base URL
    https://api.endless.health (the document declares no server; this is the origin it was published from)
  • Auth
    none declared

Request body

namestring required

Campaign name

identifierstring required

Campaign identifier in UPPER_SNAKE_CASE format. Unique across all organizations.

parent_idinteger required

Id of the sponsoring organization (must not itself be a CAMPAIGN).

configsobject nullable

Organization configurations for this campaign (validated against OrganizationConfigSchema when the Organization row is created)

api_keystring nullable

API key for this campaign (auto-generated if not provided)

activeboolean

Whether the campaign is active on creation. Defaults to inactive.

status'DRAFT' | 'ACTIVE' | 'PAUSED' | 'COMPLETED' | 'ARCHIVED'
start_datestring date nullable
end_datestring date nullable
goal_screenedinteger nullable
descriptionstring nullable

Response

Successful Response

idinteger required
namestring required
identifierstring required
parent_idinteger nullable required
activeboolean required
api_keystring nullable required
created_atstring date-time required
updated_atstring date-time required

Changes

No recorded changes to this operation across all 2 revisions of this API.