Create Program

POST 
/program/api/v1/projects/:projectID/programs

Create a new program with default composition

Generate JWT

Request

Path Parameters

projectID stringrequired

ID of the project

application/json

Body

required

Program to create

id string
projectID string
programName string
programSlug stringrequired
clientReferrer string
defaultComposition string
mode string
createdBy string
updatedBy string
createdOn string
updatedOn string

Responses

201

Program created

application/json

Schema

Schema

id string
projectID string
programName string
programSlug stringrequired
clientReferrer string
defaultComposition string
mode string
createdBy string
updatedBy string
createdOn string
updatedOn string

Example (from schema)

{
  "id": "string",
  "projectID": "string",
  "programName": "string",
  "programSlug": "string",
  "clientReferrer": "string",
  "defaultComposition": "string",
  "mode": "string",
  "createdBy": "string",
  "updatedBy": "string",
  "createdOn": "string",
  "updatedOn": "string"
}

400

Bad Request

application/json

Schema

Schema

message stringrequired

Error message for the end user

errorCode string

Code that can be set that supplies a specific reason for why a request failed

invalidFields

object[]

Specific error scoped to a field

Array [

name stringrequired

reason stringrequired

errorCode string

]

internal string

Internal user only

Example (from schema)

{
  "message": "string",
  "errorCode": "string",
  "invalidFields": [
    {
      "name": "string",
      "reason": "string",
      "errorCode": "string"
    }
  ],
  "internal": "string"
}

500

Internal Server Error

application/json

Schema

Schema

message stringrequired

Error message for the end user

errorCode string

Code that can be set that supplies a specific reason for why a request failed

invalidFields

object[]

Specific error scoped to a field

Array [

name stringrequired

reason stringrequired

errorCode string

]

internal string

Internal user only

Example (from schema)

{
  "message": "string",
  "errorCode": "string",
  "invalidFields": [
    {
      "name": "string",
      "reason": "string",
      "errorCode": "string"
    }
  ],
  "internal": "string"
}

Loading...