{"_id":"56fbe1904c3cea190015d9db","editedParams":true,"editedParams2":true,"parentDoc":null,"user":"56caca84245b841300806def","version":{"_id":"56cacb1cc675f50b00a4b61c","project":"56cacb1bc675f50b00a4b619","__v":14,"createdAt":"2016-02-22T08:47:24.528Z","releaseDate":"2016-02-22T08:47:24.528Z","categories":["56cacb1dc675f50b00a4b61d","56cc10aaca43550b0028125a","56cc10b7b4cbcf0b004a5df9","56cc1bb2272aa4130002ccd2","56cc5834b4cbcf0b004a5f8b","56cda18bface161300dae13b","56d51f2873dcd20b00fb87bb","56fbe0610023171700b96105","57658310c176520e00ea9076","5772bdd48c48e00e00503638","577c1dfe87acf617003c3fcd","579525172979790e00771a15","582b4661cdfdc125000c8684","586365cedfe6cc3700a7be63"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1"},"project":"56cacb1bc675f50b00a4b619","__v":1,"category":{"_id":"56fbe0610023171700b96105","__v":0,"project":"56cacb1bc675f50b00a4b619","version":"56cacb1cc675f50b00a4b61c","sync":{"url":"","isSync":false},"reference":true,"createdAt":"2016-03-30T14:19:13.684Z","from_sync":false,"order":8,"slug":"user-referral-api","title":"User Referral API"},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-03-30T14:24:16.027Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[]},"method":"get","results":{"codes":[{"language":"json","status":200,"name":"","code":"{\n  \"code\": 200,\n  \"status\": \"success\"\n}"},{"code":"{\n  \"code\": err_code,\n  \"staus\":\"fail\",\n  \"message\": err_message\n}","language":"json","status":400,"name":""}]},"settings":"","auth":"required","params":[{"_id":"56cc58ea8fa8b01b00b81ea3","ref":"","in":"path","required":true,"desc":"","default":"","type":"string","name":"customer_id"},{"_id":"56fbe1904c3cea190015d9dc","ref":"","in":"path","required":true,"desc":"Referral code received from the other user","default":"","type":"string","name":"code"}],"url":"/v:version/services/referral/claim/:customer_id/:code"},"isReference":true,"order":1,"body":"More: [Referral Callback Hooks](http://docs.codemojo.io/v1/page/referral-callbacks-hooks)","excerpt":"Consumes the referral code generated by other user (ex. User A generated code will be consumed by User B)","slug":"use-referral-code","type":"endpoint","title":"Use Referral Code"}

getUse Referral Code

Consumes the referral code generated by other user (ex. User A generated code will be consumed by User B)

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

customer_id:
required
string
code:
required
string
Referral code received from the other user

Result Format


Documentation

More: [Referral Callback Hooks](http://docs.codemojo.io/v1/page/referral-callbacks-hooks)

User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}