Program API

Manage programs, certificates, and enrollments with the Program API.

The Program API provides secure endpoints for creating, retrieving, updating, and managing programs, certificates, and enrollments within the Marketplace Platform.

With this API, you can also perform additional operations, including:

• Publish and unpublish programs.

• Update program settings.

• Manage program groups and parameters.

• Create and manage program documents, media, and terms & conditions.

• Create and manage program templates.

• Submit and retrieve enrollment requests.

• Validate enrollments in the draft and querying states.

• Manage attachments associated with enrollments.

• Process or fail enrollment requests.

• Retrieve an enrollment's template.

Try APIDownload API

Core Concepts

The Program API is built around the following core resources:

• Certificate - Issued to a client or partner as confirmation that they meet a specific program's requirements.

• Enrollment - Process through which a client formally registers or signs up to participate in a vendor program.

• Program - Represents a set of requirements (parameters) that vendors ask their clients to meet.

Collections

The API is organized into collections, each containing a set of operations. Access to these operations varies by role, depending on whether you are a client, vendor, or operations user.

Refer to the following capability matrix to see which roles are authorized to perform specific operations within each collection:

Certificates

Capability	Client	Vendor	Operations
List certificates	✅	✅	✅
Get certificate	✅	✅	✅
Create certificate	❌	❌	✅
Update certificate	✅	✅	✅
Terminate certificate	❌	✅	❌
Expire certificate	❌	✅	❌
Get certificate template	✅	✅	✅

Enrollments

Capability	Client	Vendor	Operations
List enrollments	✅	✅	✅
Get enrollment	✅	✅	✅
Update enrollment	✅	✅	✅
Create enrollment	✅	❌	❌
Validates draft enrollment
Validates querying enrollment	✅	✅	❌
Process enrollment	✅	✅	✅
Query enrollment	❌	✅	❌
Complete enrollment	❌	✅	❌
Fail enrollment	❌	✅	❌
Assign enrollment	❌	✅	❌
Delete enrollment	✅	❌	❌
Render enrollment template	✅	✅	✅
List of enrollment attachments	✅	❌	✅
Get single enrollment attachment by id	✅	❌	✅
Create new enrollment attachment	✅	❌	✅
Update enrollment attachment	✅	❌	✅
Delete enrollment attachment	✅	❌	✅

Programs

Capability	Client	Vendor	Operations
List programs	✅	✅	✅
Get program	✅	✅	✅
Create program	❌	✅	❌
Update program by ID	❌	✅	❌
Delete program	❌	✅	❌
Publish program	❌	✅	❌
Unpublish program	❌	✅	❌
Update program settings	❌	✅	❌

Program Parameters

Capability	Client	Vendor	Operations
List parameters for a program	✅	✅	✅
Get program parameter	✅	✅	✅
Create parameter	❌	✅	❌
Update parameter	❌	✅	❌
Delete program parameter	❌	✅	❌

Program Parameter Groups

Capability	Client	Vendor	Operations
List parameter groups	✅	✅	✅
Get parameter group	✅	✅	✅
Create parameter group	❌	✅	❌
Update parameter group	❌	✅	❌
Delete parameter group	❌	✅	❌

Program Documents

Capability	Client	Vendor	Operations
List documents	✅	✅	✅
Get document	✅	✅	✅
Create document	❌	✅	❌
Update document	❌	✅	❌
Delete document	❌	✅	❌
Publish document	❌	✅	❌
Unpublish document	❌	✅	❌

Program Media

Capability	Client	Vendor	Operations
List program media	✅	✅	✅
Get program media	✅	✅	✅
Create program media	❌	✅	❌
Update program media	❌	✅	❌
Delete program media	❌	✅	❌
Publish program media	❌	✅	❌
Unpublish program media	❌	✅	❌

Program Terms

Capability	Client	Vendor	Operations
List all terms	✅	✅	✅
Get terms	✅	✅	✅
Create terms	❌	✅	❌
Update terms	❌	✅	❌
Delete terms	❌	✅	❌
Publish terms	❌	✅	❌
Unpublish terms	❌	✅	❌

Program Terms Variants

Capability	Client	Vendor	Operations
List all terms	✅	✅	✅
Get terms	✅	✅	✅
Create terms	❌	✅	❌
Update terms	❌	✅	❌
Delete terms	❌	✅	❌
Publish terms	❌	✅	❌
Unpublish terms	❌	✅	❌

Program Templates

Capability	Client	Vendor	Operations
List program template	✅	✅	✅
Get program template	✅	✅	✅
Create program template	❌	✅	❌
Update program template	❌	✅	❌
Delete program template	❌	✅	❌

Program Webhooks

Capability	Client	Vendor	Operations
List program webhook	✅	✅	✅
Get program webhook	✅	✅	✅
Create program webhook	❌	✅	❌
Update program webhook	❌	✅	❌
Delete program webhook	❌	✅	❌