Skip to content

Create New Member

John McCarthy edited this page Nov 26, 2013 · 27 revisions

POST /api/movements/:movement_id/members(.:format)

Creates a new Member on Platform for given movement id.
Note: This is intended to be used from the Join page, where only the member's email is supplied, therefore any other member fields sent on the request will be ignored and won't be assigned to the new member.

Parameters
movement_id
Mandatory
Movement Id for which we want to create a new Member
member[email]
Mandatory
New Member Email Adress
t
Optional
Email tracking hash

Response

Status Code

201 if Successful
422 if Failed

Content

Field Description
success Boolean value indicating if member creation succedeed or not
next_page_identifier Slug of the page to redirect users after member's creation
member_id Created member's internal ID
errors Array of error messages (if success=false)
Member's fields
i.e.: first_name, last_name, email, etc.
See Member

Example Request

POST /api/movements/test-movement/members.json
Content-Type: application/x-www-form-urlencoded

member%5Bemail%5D=newmember%40example.com

Example Response

201 (Created)
Content-Type: application/json

{"success":true,
"next_page_identifier":1001,
"member_id":123,
"country_iso":null,
 "email":"[email protected]",
 "first_name":null,
 "home_number":null,
 "id":123,
 "last_name":null,
 "mobile_number":null,
 "postcode":null,
 "street_address":null,
 "suburb":null,
}

back