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

idstring
projectIDstring
programNamestring
programSlugstringrequired
clientReferrerstring
defaultCompositionstring
modestring
createdBystring
updatedBystring
createdOnstring
updatedOnstring

Responses

201

Program created

application/json

Schema

Schema

idstring
projectIDstring
programNamestring
programSlugstringrequired
clientReferrerstring
defaultCompositionstring
modestring
createdBystring
updatedBystring
createdOnstring
updatedOnstring

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

messagestringrequired

Error message for the end user

errorCodestring

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

invalidFields

object[]

Specific error scoped to a field

Array [

namestringrequired

reasonstringrequired

errorCodestring

]

internalstring

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

messagestringrequired

Error message for the end user

errorCodestring

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

invalidFields

object[]

Specific error scoped to a field

Array [

namestringrequired

reasonstringrequired

errorCodestring

]

internalstring

Internal user only

Example (from schema)

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