Create Program
POSThttps://platform.nativeframe.com/program/api/v1/projects/:projectID/programs
Create a new program with default composition
Generate JWTRequest
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
- 400
- 500
Program created
- application/json
- Schema
- Example (from schema)
Schema
idstring
projectIDstring
programNamestring
programSlugstringrequired
clientReferrerstring
defaultCompositionstring
modestring
createdBystring
updatedBystring
createdOnstring
updatedOnstring
{
"id": "string",
"projectID": "string",
"programName": "string",
"programSlug": "string",
"clientReferrer": "string",
"defaultComposition": "string",
"mode": "string",
"createdBy": "string",
"updatedBy": "string",
"createdOn": "string",
"updatedOn": "string"
}
Bad Request
- application/json
- Schema
- Example (from 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[]
internalstring
Internal user only
{
"message": "string",
"errorCode": "string",
"invalidFields": [
{
"name": "string",
"reason": "string",
"errorCode": "string"
}
],
"internal": "string"
}
Internal Server Error
- application/json
- Schema
- Example (from 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[]
internalstring
Internal user only
{
"message": "string",
"errorCode": "string",
"invalidFields": [
{
"name": "string",
"reason": "string",
"errorCode": "string"
}
],
"internal": "string"
}
Authorization: http
name: JWTtype: httpscopes: aud:internal-account,service-account,roles:internal-account,service-account
scheme: bearerbearerFormat: JWTdescription: Bearer Token authentication for applications
- csharp
- curl
- dart
- go
- http
- java
- javascript
- kotlin
- c
- nodejs
- objective-c
- ocaml
- php
- powershell
- python
- r
- ruby
- rust
- shell
- swift
- HTTPCLIENT
- RESTSHARP
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "https://platform.nativeframe.com/program/api/v1/projects/:projectID/programs");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("Authorization", "Bearer <token>");
var content = new StringContent("{\n \"id\": \"string\",\n \"projectID\": \"string\",\n \"programName\": \"string\",\n \"programSlug\": \"string\",\n \"clientReferrer\": \"string\",\n \"defaultComposition\": \"string\",\n \"mode\": \"string\",\n \"createdBy\": \"string\",\n \"updatedBy\": \"string\",\n \"createdOn\": \"string\",\n \"updatedOn\": \"string\"\n}", null, "application/json");
request.Content = content;
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());
ResponseClear