For Developers

Create Product

POST https://ed.link/api/v2/teams/:team_id/products

Creates a new catalog product that can be licensed across integrations.

Permissions

Requires the products.create system permission.

Parameters

ParameterTypeRequiredDescription
:team_idUUIDYesThe ID of the team.

Request Body

PropertyTypeRequiredDescription
nameStringYesName of the product.
codeStringYesUnique SKU or code within your team.
descriptionStringNoDescriptive summary of the product.
picture_urlStringNoImage URL for display in portals.
stateStringNoInitial state (active or inactive).

Sample Request

const response = await axios.post(
    `https://ed.link/api/v2/teams/${team_id}/products`,
    {
        name: 'Math Mastery Suite - Grade 6-8',
        code: 'MMS-G68',
        description: 'Comprehensive middle school math software package',
        state: 'active'
    },
    {
        headers: {
            authorization: `Bearer ${user_session_token}`,
            'content-type': 'application/json'
        }
    }
);

Sample Response

{
    "$data": {
        "id": "e891024b-3211-479c-9c3f-918239023412",
        "name": "Math Mastery Suite - Grade 6-8",
        "code": "MMS-G68",
        "description": "Comprehensive middle school math software package",
        "state": "active",
        "team_id": "6a9e99a8-e165-4d0d-9b7d-6062a4be682d"
    }
}