ENendless
admin
organizations

Create Organization

post/api/v3/admin/organizations/

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

Organization name

identifierstring required

Organization identifier in UPPER_SNAKE_CASE format (only uppercase letters, numbers, and underscores)

api_keystring nullable

API key for this organization (optional, will be auto-generated if not provided)

organization_type'ENTITY' | 'SPONSOR' | 'CAMPAIGN'

Discriminates the kind of organization row.

ENTITY: standalone customer account. SPONSOR: parent account that runs one or more campaigns. CAMPAIGN: a child organization for a single screening program; requires parent_id.

parent_idinteger nullable

Parent organization id. Required for CAMPAIGN; the parent must not itself be a CAMPAIGN.

activeboolean

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

Example request

{
  "configs": {
    "auto_reorder_kit": false,
    "body_health": false,
    "webhooks_enabled": false
  },
  "identifier": "ENDLESS_HEALTH",
  "name": "Endless Health"
}

Response

Successful Response

idinteger required
namestring required
identifierstring required
configsobject required
api_keystring nullable required
organization_type'ENTITY' | 'SPONSOR' | 'CAMPAIGN' required

Discriminates the kind of organization row.

ENTITY: standalone customer account. SPONSOR: parent account that runs one or more campaigns. CAMPAIGN: a child organization for a single screening program; requires parent_id.

parent_idinteger nullable required
activeboolean 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.