Skip to main content
PATCH
Update program

Authorizations

Authorization
string
header
required

API key authentication. Include your API key as a Bearer token.

Example: Bearer sk_prod_xxxxxx

Get your API key from the Stell Dashboard.

Path Parameters

programId
string
required

Body

application/json

Fields to update on an existing program.

country
string

ISO 3166-1 alpha-2 country code for the program operating country

Pattern: ^[A-Z]{2}$
merchantId
string

Update merchant association (can be set or cleared)

displayName
string

Public-facing program name (max 100 characters)

Maximum string length: 100
name
string

Internal program name (2-100 characters)

Required string length: 2 - 100
description
string

Program description shown to customers (max 500 characters)

Maximum string length: 500
status
enum<string>

Update program lifecycle status

Available options:
DRAFT,
PUBLISHED,
DELETED,
ARCHIVED

Response

200 response

Response envelope carrying a program.

data
ProgramModel · object
required

Pass program configuration.

requestId
string
required

Unique request identifier for debugging

Pattern: ^[0-9A-Z]{26}$