Password Reset Email

Request Details

Item	Value
Description	For accounts with CrowdTwist hosted registration, this allows for a password reset email to be triggered.
Method	POST
Endpoint	https://[environment]api[client_id].crowdtwist.com/v2/users/[user_id]/password_reset_email?api_key=[api_key]&id_type=[id_type]
Content Type	application/x-www-form-urlencoded

Request

Field Name	Sample Value	Required	Format	Notes
URL PARAMETERS
user_id	alice@crowdtwist.com	Yes	String	Unique ID of the user for whom activities will be returned: Options: – Email Address – Facebook User ID – Twitter User ID – CrowdTwist ID – Third Party ID – Username – Mobile Phone Number
QUERY STRING PARAMETERS
api_key	QWERTYUIOP	Yes	String
id_type	email	No	String	Type of ID being Sent: Options: – email – facebook_user_id – twitter_user_id – id (CrowdTwist ID) – default ID if id_type is not specified – third_party_id – username – mobile_phone_number

Successful Response

Field Name	Sample Value	Required	Format	Description
client_name	CrowdTwist Rewards	Yes	String	The name of the client with which the user is registered.
email_address	alice@crowdtwist.com	Yes	Sring	The email address with which the user is registered.
first_name	Alice	Yes	String	The first name of the user.
last_name	Twist	Yes	String	The last name of the user

Error Response

Field Name	Sample Value	Required	Format	Description
error	page_not_found	Yes	String	A machine readable code that describes the error.
message	User does not exist.	Yes	String	A short, descriptive sentence detailing the error.

Error Response Codes

Error	Message
input_error	The input provided in invalid or formatted incorrectly.
internal_error	Something went wrong on our end.
forbidden	Registration is hosted by the client.
forbidden	User is inactive.
page_not_found	User does not exist.

Sample Request

curl -X POST
https://api.crowdtwist.com/v2/users/alice@crowdtwist.com/password_reset_email?api_key=QWERTYUIOP&id_type=email

curl -X POST
https://api.crowdtwist.com/v2/users/alice@crowdtwist.com/password_reset_email?api_key=QWERTYUIOP&id_type=email

Sample Successful Response: Status Code 200

{
  "client_name": "CrowdTwist Rewards",
  "email_address": "alice@crowdtwist.com",
  "first_name": "Alice",
  "last_name": "Twist"
}

{
  "client_name": "CrowdTwist Rewards",
  "email_address": "alice@crowdtwist.com",
  "first_name": "Alice",
  "last_name": "Twist"
}

Sample Error Response: Status Code 400

{
   "error": "page_not_found",
   "message": "User does not exist."
}

{
   "error": "page_not_found",
   "message": "User does not exist."
}