Skip to main content

OptInCompleteRequest

The opt-in registration submission. first_name, email, and role are required; everything else is optional and, when present, updates the podcast. blocked_categories becomes the podcast's excluded advertiser categories. voice_id (a voice created via the opt-in voice pipeline) is linked as the podcast's primary voice when supplied.

first_namestringnullable

Recipient's first name. Required to complete opt-in.

Example: Jordan
last_namestringnullable

Recipient's last name.

Example: Rivera
emailstringnullable

Recipient's contact email. Required to complete opt-in; must be a valid email address.

Example: recipient@example.com
phone_numberstringnullable

Recipient's phone number.

Example: +1-415-555-0142
rolestringnullable

Recipient's role with respect to the podcast (free-form, e.g. host or producer). Required to complete opt-in.

Example: host
titlestringnullable

Updated podcast title; when present it overwrites the stored title.

Example: The Daily Tech Roundup
descriptionstringnullable

Updated podcast description; when present it overwrites the stored description.

Example: A short daily look at the latest in technology.
linkstringnullable

Updated podcast website or landing-page URL.

Example: https://example.com/podcast
image_urlstringnullable

Updated podcast cover-image URL.

Example: https://example.com/cover.jpg
categoriesstring[]nullable

Podcast content categories; when non-empty it replaces the stored categories.

languagestringnullable

Podcast primary language as a 2-letter ISO-639-1 code.

Example: en
downloads_per_monthint64nullable

Estimated monthly downloads; ignored if negative.

Example: 125000
blocked_categoriesstring[]nullable

Advertiser categories the recipient wants to exclude; becomes the podcast's excluded advertiser categories.

additional_notesstringnullable

Free-form notes the recipient wants to attach to the opt-in.

Example: Prefer ads read in the host's own voice.
external_ids objectnullable

Optional partner-defined external identifiers to store on the podcast, keyed by system name.

property name*string
voice_idstringnullable

Id of a READY voice created via the opt-in voice pipeline to link as the podcast's primary voice. Must belong to this podcast and be finalized.

Example: 7Hb2Kp9QvL3mNx0R8tZ4
voice_namestringnullable

Display name to store for the linked voice.

Example: Host Voice
OptInCompleteRequest
{
  "first_name": "Jordan",
  "last_name": "Rivera",
  "email": "recipient@example.com",
  "phone_number": "+1-415-555-0142",
  "role": "host",
  "title": "The Daily Tech Roundup",
  "description": "A short daily look at the latest in technology.",
  "link": "https://example.com/podcast",
  "image_url": "https://example.com/cover.jpg",
  "categories": [
    "string"
  ],
  "language": "en",
  "downloads_per_month": 125000,
  "blocked_categories": [
    "string"
  ],
  "additional_notes": "Prefer ads read in the host's own voice.",
  "external_ids": {},
  "voice_id": "7Hb2Kp9QvL3mNx0R8tZ4",
  "voice_name": "Host Voice"
}