[{"data":1,"prerenderedAt":-1},["ShallowReactive",2],{"docs-\u002Fdocs\u002Fapi\u002Fendpoints\u002Fsubscribers\u002Fupdate-subscriber":3},{"_path":4,"title":5,"description":6,"navigation":7,"image":13,"head":18,"body":32},"\u002Fdocs\u002Fapi\u002Fendpoints\u002Fsubscribers\u002Fupdate-subscriber","Update Subscriber API Endpoint · Waitlister Documentation","Learn how to update subscriber information programmatically using the Waitlister API.",{"title":8,"parent":9,"group":10,"description":11,"order":12},"Update Subscriber","Endpoints","Advanced","Update subscriber information including name, phone, points, and metadata.",4,{"src":14,"width":15,"height":16,"alt":17},"https:\u002F\u002Ffirebasestorage.googleapis.com\u002Fv0\u002Fb\u002Fwaitinglist-app-c24fc.appspot.com\u002Fo\u002Fdocs-og-image.png?alt=media&token=85e60b24-c882-4f84-aa9e-ef85e1ae4bb5",400,300,"Waitlister API Update Subscriber",{"meta":19},[20,23,26,29],{"name":21,"content":22},"keywords","update subscriber, edit subscriber, waitlist api, api integration, subscriber management",{"name":24,"content":25},"robots","index, follow",{"name":27,"content":28},"author","Waitlister",{"name":30,"content":31},"copyright","© 2026 Waitlister",{"type":33,"children":34,"toc":741},"root",[35,49,55,60,67,105,111,118,128,134,196,202,213,220,333,338,344,357,366,372,531,537,550,559,571,580,586,592,603,609,618,624,630,642,666,672,684,692,698,703,716,721,727],{"type":36,"tag":37,"props":38,"children":39},"element","p",{},[40],{"type":36,"tag":41,"props":42,"children":45},"span",{"className":43},[44],"secondary-heading",[46],{"type":47,"value":48},"text","API Reference \u002F Endpoints",{"type":36,"tag":50,"props":51,"children":53},"h1",{"id":52},"update-subscriber",[54],{"type":47,"value":8},{"type":36,"tag":37,"props":56,"children":57},{},[58],{"type":47,"value":59},"The Update Subscriber endpoint allows you to modify information for an existing subscriber. You can update their name, phone number, points, and custom metadata fields.",{"type":36,"tag":61,"props":62,"children":64},"h2",{"id":63},"endpoint-details",[65],{"type":47,"value":66},"Endpoint Details",{"type":36,"tag":68,"props":69,"children":70},"ul",{},[71,90],{"type":36,"tag":72,"props":73,"children":74},"li",{},[75,81,83],{"type":36,"tag":76,"props":77,"children":78},"strong",{},[79],{"type":47,"value":80},"URL",{"type":47,"value":82},": ",{"type":36,"tag":84,"props":85,"children":87},"code",{"className":86},[],[88],{"type":47,"value":89},"https:\u002F\u002Fwaitlister.me\u002Fapi\u002Fv1\u002Fwaitlist\u002F{waitlist-key}\u002Fsubscribers\u002F{id-or-email}",{"type":36,"tag":72,"props":91,"children":92},{},[93,98,99],{"type":36,"tag":76,"props":94,"children":95},{},[96],{"type":47,"value":97},"Method",{"type":47,"value":82},{"type":36,"tag":84,"props":100,"children":102},{"className":101},[],[103],{"type":47,"value":104},"PUT",{"type":36,"tag":61,"props":106,"children":108},{"id":107},"request",[109],{"type":47,"value":110},"Request",{"type":36,"tag":112,"props":113,"children":115},"h3",{"id":114},"headers",[116],{"type":47,"value":117},"Headers",{"type":36,"tag":119,"props":120,"children":122},"pre",{"code":121},"Content-Type: application\u002Fjson\nX-Api-Key: your-api-key\n",[123],{"type":36,"tag":84,"props":124,"children":126},{"__ignoreMap":125},"",[127],{"type":47,"value":121},{"type":36,"tag":112,"props":129,"children":131},{"id":130},"path-parameters",[132],{"type":47,"value":133},"Path Parameters",{"type":36,"tag":135,"props":136,"children":137},"table",{},[138,157],{"type":36,"tag":139,"props":140,"children":141},"thead",{},[142],{"type":36,"tag":143,"props":144,"children":145},"tr",{},[146,152],{"type":36,"tag":147,"props":148,"children":149},"th",{},[150],{"type":47,"value":151},"Parameter",{"type":36,"tag":147,"props":153,"children":154},{},[155],{"type":47,"value":156},"Description",{"type":36,"tag":158,"props":159,"children":160},"tbody",{},[161,179],{"type":36,"tag":143,"props":162,"children":163},{},[164,174],{"type":36,"tag":165,"props":166,"children":167},"td",{},[168],{"type":36,"tag":84,"props":169,"children":171},{"className":170},[],[172],{"type":47,"value":173},"waitlist-key",{"type":36,"tag":165,"props":175,"children":176},{},[177],{"type":47,"value":178},"Your unique waitlist key, found in your waitlist settings",{"type":36,"tag":143,"props":180,"children":181},{},[182,191],{"type":36,"tag":165,"props":183,"children":184},{},[185],{"type":36,"tag":84,"props":186,"children":188},{"className":187},[],[189],{"type":47,"value":190},"id-or-email",{"type":36,"tag":165,"props":192,"children":193},{},[194],{"type":47,"value":195},"Either the subscriber's unique ID or their email address",{"type":36,"tag":112,"props":197,"children":199},{"id":198},"request-body",[200],{"type":47,"value":201},"Request Body",{"type":36,"tag":119,"props":203,"children":208},{"code":204,"language":205,"meta":125,"className":206},"{\n  \"name\": \"Updated Name\",\n  \"phone\": \"+1987654321\",\n  \"points\": 200,\n  \"metadata\": {\n    \"company\": \"New Company\",\n    \"status\": \"qualified\"\n  }\n}\n","json",[207],"language-json",[209],{"type":36,"tag":84,"props":210,"children":211},{"__ignoreMap":125},[212],{"type":47,"value":204},{"type":36,"tag":214,"props":215,"children":217},"h4",{"id":216},"optional-fields",[218],{"type":47,"value":219},"Optional Fields",{"type":36,"tag":135,"props":221,"children":222},{},[223,243],{"type":36,"tag":139,"props":224,"children":225},{},[226],{"type":36,"tag":143,"props":227,"children":228},{},[229,234,239],{"type":36,"tag":147,"props":230,"children":231},{},[232],{"type":47,"value":233},"Field",{"type":36,"tag":147,"props":235,"children":236},{},[237],{"type":47,"value":238},"Type",{"type":36,"tag":147,"props":240,"children":241},{},[242],{"type":47,"value":156},{"type":36,"tag":158,"props":244,"children":245},{},[246,268,289,311],{"type":36,"tag":143,"props":247,"children":248},{},[249,258,263],{"type":36,"tag":165,"props":250,"children":251},{},[252],{"type":36,"tag":84,"props":253,"children":255},{"className":254},[],[256],{"type":47,"value":257},"name",{"type":36,"tag":165,"props":259,"children":260},{},[261],{"type":47,"value":262},"String",{"type":36,"tag":165,"props":264,"children":265},{},[266],{"type":47,"value":267},"The subscriber's updated name",{"type":36,"tag":143,"props":269,"children":270},{},[271,280,284],{"type":36,"tag":165,"props":272,"children":273},{},[274],{"type":36,"tag":84,"props":275,"children":277},{"className":276},[],[278],{"type":47,"value":279},"phone",{"type":36,"tag":165,"props":281,"children":282},{},[283],{"type":47,"value":262},{"type":36,"tag":165,"props":285,"children":286},{},[287],{"type":47,"value":288},"The subscriber's updated phone number",{"type":36,"tag":143,"props":290,"children":291},{},[292,301,306],{"type":36,"tag":165,"props":293,"children":294},{},[295],{"type":36,"tag":84,"props":296,"children":298},{"className":297},[],[299],{"type":47,"value":300},"points",{"type":36,"tag":165,"props":302,"children":303},{},[304],{"type":47,"value":305},"Number",{"type":36,"tag":165,"props":307,"children":308},{},[309],{"type":47,"value":310},"The subscriber's updated points value",{"type":36,"tag":143,"props":312,"children":313},{},[314,323,328],{"type":36,"tag":165,"props":315,"children":316},{},[317],{"type":36,"tag":84,"props":318,"children":320},{"className":319},[],[321],{"type":47,"value":322},"metadata",{"type":36,"tag":165,"props":324,"children":325},{},[326],{"type":47,"value":327},"Object",{"type":36,"tag":165,"props":329,"children":330},{},[331],{"type":47,"value":332},"Additional fields to add or update in the subscriber's metadata",{"type":36,"tag":37,"props":334,"children":335},{},[336],{"type":47,"value":337},"Note: You only need to include the fields you want to update. Omitted fields will remain unchanged.",{"type":36,"tag":61,"props":339,"children":341},{"id":340},"response",[342],{"type":47,"value":343},"Response",{"type":36,"tag":112,"props":345,"children":347},{"id":346},"success-response-200",[348,350],{"type":47,"value":349},"Success Response ",{"type":36,"tag":84,"props":351,"children":354},{"className":352},[353],"inline-code-green",[355],{"type":47,"value":356},"200",{"type":36,"tag":119,"props":358,"children":361},{"code":359,"language":205,"meta":125,"className":360},"{\n  \"success\": true,\n  \"message\": \"Successfully updated subscriber\",\n  \"data\": {\n    \"subscriber\": {\n      \"id\": \"xyzABC123\",\n      \"email\": \"user@example.com\",\n      \"name\": \"Updated Name\",\n      \"phone\": \"+1987654321\",\n      \"points\": 200,\n      \"sign_up_token\": \"abc123xyz\",\n      \"thank_you_url\": \"https:\u002F\u002Fwaitlister.me\u002Fthank-you\u002Fyour-waitlist-key\u002Fabc123xyz\",\n      \"updated_at\": 1682345678901,\n      \"metadata\": {\n        \"company\": \"New Company\",\n        \"status\": \"qualified\",\n        \"existing_field\": \"existing value\"\n      }\n    }\n  }\n}\n",[207],[362],{"type":36,"tag":84,"props":363,"children":364},{"__ignoreMap":125},[365],{"type":47,"value":359},{"type":36,"tag":214,"props":367,"children":369},{"id":368},"response-fields",[370],{"type":47,"value":371},"Response Fields",{"type":36,"tag":135,"props":373,"children":374},{},[375,393],{"type":36,"tag":139,"props":376,"children":377},{},[378],{"type":36,"tag":143,"props":379,"children":380},{},[381,385,389],{"type":36,"tag":147,"props":382,"children":383},{},[384],{"type":47,"value":233},{"type":36,"tag":147,"props":386,"children":387},{},[388],{"type":47,"value":238},{"type":36,"tag":147,"props":390,"children":391},{},[392],{"type":47,"value":156},{"type":36,"tag":158,"props":394,"children":395},{},[396,426,447,468,489,510],{"type":36,"tag":143,"props":397,"children":398},{},[399,408,413],{"type":36,"tag":165,"props":400,"children":401},{},[402],{"type":36,"tag":84,"props":403,"children":405},{"className":404},[],[406],{"type":47,"value":407},"success",{"type":36,"tag":165,"props":409,"children":410},{},[411],{"type":47,"value":412},"Boolean",{"type":36,"tag":165,"props":414,"children":415},{},[416,418,424],{"type":47,"value":417},"Always ",{"type":36,"tag":84,"props":419,"children":421},{"className":420},[],[422],{"type":47,"value":423},"true",{"type":47,"value":425}," for successful responses",{"type":36,"tag":143,"props":427,"children":428},{},[429,438,442],{"type":36,"tag":165,"props":430,"children":431},{},[432],{"type":36,"tag":84,"props":433,"children":435},{"className":434},[],[436],{"type":47,"value":437},"message",{"type":36,"tag":165,"props":439,"children":440},{},[441],{"type":47,"value":262},{"type":36,"tag":165,"props":443,"children":444},{},[445],{"type":47,"value":446},"A human-readable success message",{"type":36,"tag":143,"props":448,"children":449},{},[450,459,463],{"type":36,"tag":165,"props":451,"children":452},{},[453],{"type":36,"tag":84,"props":454,"children":456},{"className":455},[],[457],{"type":47,"value":458},"data.subscriber",{"type":36,"tag":165,"props":460,"children":461},{},[462],{"type":47,"value":327},{"type":36,"tag":165,"props":464,"children":465},{},[466],{"type":47,"value":467},"The updated subscriber information",{"type":36,"tag":143,"props":469,"children":470},{},[471,480,484],{"type":36,"tag":165,"props":472,"children":473},{},[474],{"type":36,"tag":84,"props":475,"children":477},{"className":476},[],[478],{"type":47,"value":479},"data.subscriber.sign_up_token",{"type":36,"tag":165,"props":481,"children":482},{},[483],{"type":47,"value":262},{"type":36,"tag":165,"props":485,"children":486},{},[487],{"type":47,"value":488},"Unique token for this subscriber",{"type":36,"tag":143,"props":490,"children":491},{},[492,501,505],{"type":36,"tag":165,"props":493,"children":494},{},[495],{"type":36,"tag":84,"props":496,"children":498},{"className":497},[],[499],{"type":47,"value":500},"data.subscriber.thank_you_url",{"type":36,"tag":165,"props":502,"children":503},{},[504],{"type":47,"value":262},{"type":36,"tag":165,"props":506,"children":507},{},[508],{"type":47,"value":509},"URL to the subscriber's thank you page",{"type":36,"tag":143,"props":511,"children":512},{},[513,522,526],{"type":36,"tag":165,"props":514,"children":515},{},[516],{"type":36,"tag":84,"props":517,"children":519},{"className":518},[],[520],{"type":47,"value":521},"data.subscriber.updated_at",{"type":36,"tag":165,"props":523,"children":524},{},[525],{"type":47,"value":305},{"type":36,"tag":165,"props":527,"children":528},{},[529],{"type":47,"value":530},"Timestamp of when the subscriber was updated",{"type":36,"tag":112,"props":532,"children":534},{"id":533},"error-responses",[535],{"type":47,"value":536},"Error Responses",{"type":36,"tag":214,"props":538,"children":540},{"id":539},"not-found-404",[541,543],{"type":47,"value":542},"Not Found ",{"type":36,"tag":84,"props":544,"children":547},{"className":545},[546],"inline-code-red",[548],{"type":47,"value":549},"404",{"type":36,"tag":119,"props":551,"children":554},{"code":552,"language":205,"meta":125,"className":553},"{\n  \"statusCode\": 404,\n  \"error\": \"Not Found\",\n  \"message\": \"Subscriber not found\"\n}\n",[207],[555],{"type":36,"tag":84,"props":556,"children":557},{"__ignoreMap":125},[558],{"type":47,"value":552},{"type":36,"tag":214,"props":560,"children":562},{"id":561},"bad-request-400",[563,565],{"type":47,"value":564},"Bad Request ",{"type":36,"tag":84,"props":566,"children":568},{"className":567},[546],[569],{"type":47,"value":570},"400",{"type":36,"tag":119,"props":572,"children":575},{"code":573,"language":205,"meta":125,"className":574},"{\n  \"statusCode\": 400,\n  \"error\": \"Bad Request\",\n  \"message\": \"At least one field to update must be provided\"\n}\n",[207],[576],{"type":36,"tag":84,"props":577,"children":578},{"__ignoreMap":125},[579],{"type":47,"value":573},{"type":36,"tag":61,"props":581,"children":583},{"id":582},"examples",[584],{"type":47,"value":585},"Examples",{"type":36,"tag":112,"props":587,"children":589},{"id":588},"update-subscriber-name-and-points",[590],{"type":47,"value":591},"Update Subscriber Name and Points",{"type":36,"tag":119,"props":593,"children":598},{"code":594,"language":595,"meta":125,"className":596},"curl -X PUT \"https:\u002F\u002Fwaitlister.me\u002Fapi\u002Fv1\u002Fwaitlist\u002Fyour-waitlist-key\u002Fsubscribers\u002FxyzABC123\" \\\n  -H \"Content-Type: application\u002Fjson\" \\\n  -H \"X-Api-Key: your-api-key\" \\\n  -d '{\n    \"name\": \"Updated Name\",\n    \"points\": 200\n  }'\n","bash",[597],"language-bash",[599],{"type":36,"tag":84,"props":600,"children":601},{"__ignoreMap":125},[602],{"type":47,"value":594},{"type":36,"tag":112,"props":604,"children":606},{"id":605},"update-subscriber-metadata",[607],{"type":47,"value":608},"Update Subscriber Metadata",{"type":36,"tag":119,"props":610,"children":613},{"code":611,"language":595,"meta":125,"className":612},"curl -X PUT \"https:\u002F\u002Fwaitlister.me\u002Fapi\u002Fv1\u002Fwaitlist\u002Fyour-waitlist-key\u002Fsubscribers\u002Fuser%40example.com\" \\\n  -H \"Content-Type: application\u002Fjson\" \\\n  -H \"X-Api-Key: your-api-key\" \\\n  -d '{\n    \"metadata\": {\n      \"status\": \"qualified\",\n      \"last_contact\": \"2023-05-15\",\n      \"notes\": \"Ready for beta access\"\n    }\n  }'\n",[597],[614],{"type":36,"tag":84,"props":615,"children":616},{"__ignoreMap":125},[617],{"type":47,"value":611},{"type":36,"tag":61,"props":619,"children":621},{"id":620},"implementation-notes",[622],{"type":47,"value":623},"Implementation Notes",{"type":36,"tag":112,"props":625,"children":627},{"id":626},"metadata-merging",[628],{"type":47,"value":629},"Metadata Merging",{"type":36,"tag":37,"props":631,"children":632},{},[633,635,640],{"type":47,"value":634},"When updating ",{"type":36,"tag":84,"props":636,"children":638},{"className":637},[],[639],{"type":47,"value":322},{"type":47,"value":641},", the new fields are merged with existing fields.",{"type":36,"tag":68,"props":643,"children":644},{},[645,650,655],{"type":36,"tag":72,"props":646,"children":647},{},[648],{"type":47,"value":649},"Fields included in the update request will be added or updated",{"type":36,"tag":72,"props":651,"children":652},{},[653],{"type":47,"value":654},"Existing fields not mentioned in the request will be preserved",{"type":36,"tag":72,"props":656,"children":657},{},[658,660],{"type":47,"value":659},"To remove a field, you would need to set its value to ",{"type":36,"tag":84,"props":661,"children":663},{"className":662},[],[664],{"type":47,"value":665},"null",{"type":36,"tag":112,"props":667,"children":669},{"id":668},"points-management",[670],{"type":47,"value":671},"Points Management",{"type":36,"tag":37,"props":673,"children":674},{},[675,677,682],{"type":47,"value":676},"The ",{"type":36,"tag":84,"props":678,"children":680},{"className":679},[],[681],{"type":47,"value":300},{"type":47,"value":683}," field can be used to reward subscribers or adjust their position.",{"type":36,"tag":68,"props":685,"children":686},{},[687],{"type":36,"tag":72,"props":688,"children":689},{},[690],{"type":47,"value":691},"You can reward subscribers for custom actions by increasing points",{"type":36,"tag":112,"props":693,"children":695},{"id":694},"subscriber-identification",[696],{"type":47,"value":697},"Subscriber Identification",{"type":36,"tag":37,"props":699,"children":700},{},[701],{"type":47,"value":702},"You can update a subscriber using either:",{"type":36,"tag":68,"props":704,"children":705},{},[706,711],{"type":36,"tag":72,"props":707,"children":708},{},[709],{"type":47,"value":710},"Their unique ID (more efficient)",{"type":36,"tag":72,"props":712,"children":713},{},[714],{"type":47,"value":715},"Their email address (more convenient for integration)",{"type":36,"tag":37,"props":717,"children":718},{},[719],{"type":47,"value":720},"Email lookups are case-insensitive. The email address is normalized to lowercase before lookup.",{"type":36,"tag":61,"props":722,"children":724},{"id":723},"rate-limits",[725],{"type":47,"value":726},"Rate Limits",{"type":36,"tag":37,"props":728,"children":729},{},[730,732,739],{"type":47,"value":731},"See ",{"type":36,"tag":733,"props":734,"children":736},"a",{"href":735},"\u002Fdocs\u002Fapi\u002Frate-limits",[737],{"type":47,"value":738},"API Rate Limits",{"type":47,"value":740}," for more information.",{"title":125,"searchDepth":742,"depth":742,"links":743},3,[744,746,753,765,769,774],{"id":63,"depth":745,"text":66},2,{"id":107,"depth":745,"text":110,"children":747},[748,749,750],{"id":114,"depth":742,"text":117},{"id":130,"depth":742,"text":133},{"id":198,"depth":742,"text":201,"children":751},[752],{"id":216,"depth":12,"text":219},{"id":340,"depth":745,"text":343,"children":754},[755,759],{"id":346,"depth":742,"text":756,"children":757},"Success Response 200",[758],{"id":368,"depth":12,"text":371},{"id":533,"depth":742,"text":536,"children":760},[761,763],{"id":539,"depth":12,"text":762},"Not Found 404",{"id":561,"depth":12,"text":764},"Bad Request 400",{"id":582,"depth":745,"text":585,"children":766},[767,768],{"id":588,"depth":742,"text":591},{"id":605,"depth":742,"text":608},{"id":620,"depth":745,"text":623,"children":770},[771,772,773],{"id":626,"depth":742,"text":629},{"id":668,"depth":742,"text":671},{"id":694,"depth":742,"text":697},{"id":723,"depth":745,"text":726}]