Sponsors

Sponsor name normalization

GET /sponsors

List all sponsors

Returns list of all known sponsors with their aliases and metadata

Parameters

• include_inactive (query, boolean): Include inactive (deleted) sponsors

Responses

Status	Description	Body
200	List of sponsors	object

200 response body

• sponsors (array of Sponsor)

POST /sponsors

Add a new sponsor

Create a new sponsor entry with optional aliases and category

Request body (application/json, required)

• name (string, required): Canonical sponsor name
• aliases (array of string): Alternative names for this sponsor
• category (string): Sponsor category
• segment_category (string or null, one of sponsor, cross_promo, self_promo, interaction, intro, outro, recap, null): Segment category applied to every read naming this sponsor

Responses

Status	Description	Body
201	Sponsor created	object
400	Bad request - invalid input	Error
409	Sponsor already exists	Error

201 response body

• message (string)
• id (integer)

GET /sponsors/{sponsor_id}

Get a single sponsor

Returns details for a specific sponsor by ID

Parameters

• sponsor_id (path, integer, required): Sponsor identifier (integer)

Responses

Status	Description	Body
200	Sponsor details	Sponsor
404	Resource not found	Error

PUT /sponsors/{sponsor_id}

Update a sponsor

Update sponsor properties. Any subset of the fields may be sent.

Parameters

• sponsor_id (path, integer, required): Sponsor identifier (integer)

Request body (application/json, required)

• name (string)
• aliases (array of string)
• category (string)
• segment_category (string or null, one of sponsor, cross_promo, self_promo, interaction, intro, outro, recap, null): Segment category applied to every read naming this sponsor; null clears it
• tags (array of string): Community tags for grouping and filtering
• common_ctas (array of string): Common calls-to-action associated with this sponsor
• is_active (boolean): Set false to deactivate, true to reactivate

Responses

Status	Description	Body
200	Sponsor updated	object
400	Bad request - invalid input	Error
404	Resource not found	Error

200 response body

• message (string)

DELETE /sponsors/{sponsor_id}

Delete a sponsor

Permanently remove a sponsor. Any ad patterns linked to it are unlinked (their sponsor_id is set to null), not deleted, so no pattern data is lost.

Parameters

• sponsor_id (path, integer, required): Sponsor identifier (integer)

Responses

Status	Description	Body
200	Sponsor deleted	object
404	Resource not found	Error

200 response body

• message (string)
• unlinkedPatterns (integer): Number of ad patterns that were unlinked

GET /sponsors/normalizations

List sponsor normalizations

Returns list of sponsor name normalization rules with optional filtering

Parameters

• category (query, string, one of sponsor, url, number, phrase): Filter by normalization category
• include_inactive (query, boolean): Include inactive normalizations

Responses

Status	Description	Body
200	List of normalizations	object

200 response body

• normalizations (array of Normalization)

POST /sponsors/normalizations

Add a normalization rule

Create a sponsor name normalization rule. terms is a regex pattern applied case-insensitively; canonical is its replacement. The legacy field names pattern/replacement are still accepted on write. The regex is validated on create and rejected with 400 if invalid.

Request body (application/json, required)

• terms (string, required): Regex pattern to match (legacy alias - pattern)
• canonical (string, required): Replacement text (legacy alias - replacement)
• category (string, one of sponsor, url, number, phrase, required): Normalization category

Responses

Status	Description	Body
201	Normalization created	object
400	Bad request - invalid input	Error

201 response body

• message (string)
• id (integer)

PUT /sponsors/normalizations/{norm_id}

Update a normalization rule

Update a normalization rule. Any subset of fields may be sent. The legacy field names pattern/replacement are still accepted in place of terms/canonical.

Parameters

• norm_id (path, integer, required): Normalization rule identifier (integer)

Request body (application/json, required)

• terms (string): Regex pattern to match (legacy alias - pattern)
• canonical (string): Replacement text (legacy alias - replacement)
• category (string, one of sponsor, url, number, phrase)

Responses

Status	Description	Body
200	Normalization updated	object
400	Bad request - invalid input	Error
404	Resource not found	Error

200 response body

• message (string)

DELETE /sponsors/normalizations/{norm_id}

Delete a normalization rule

Deactivate a normalization rule (soft delete)

Parameters

• norm_id (path, integer, required): Normalization rule identifier (integer)

Responses

Status	Description	Body
200	Normalization deleted	object
404	Resource not found	Error

200 response body

• message (string)

PUT /sponsors/{sponsor_id}/tags

Update a sponsor’s tags

Parameters

• sponsor_id (path, integer, required)

Request body (application/json, required)

• tags (array of string, required)

Responses

Status	Description	Body
200	Updated sponsor tags
404	Sponsor not found