POST Users/Signup

Signup user

Request Information

URI Parameters

None.

Body Parameters

RequestUsersSignup
NameDescriptionTypeAdditional information
FacebookAccessToken

If FacebookAccessToken (accessToken or authenticationToken when using limited.facebook.com) is sent, the following fields do not need to be entered as API will pull this from Facebook > UserEmail, FirstName, LastName

string

None.

AppleToken

UserEmail, FirstName, LastName is required when using AppleToken

string

None.

UserEmail

string

None.

UserPassword

string

None.

FirstName

string

None.

LastName

string

None.

ReceiveNewsletter

boolean

None.

FilterIDs

Collection of integer

None.

Request Formats

application/json, text/json

Sample:
{
  "FacebookAccessToken": "sample string 1",
  "AppleToken": "sample string 2",
  "UserEmail": "sample string 3",
  "UserPassword": "sample string 4",
  "FirstName": "sample string 5",
  "LastName": "sample string 6",
  "ReceiveNewsletter": true,
  "FilterIDs": [
    1,
    2
  ]
}

text/html

Sample:
{"FacebookAccessToken":"sample string 1","AppleToken":"sample string 2","UserEmail":"sample string 3","UserPassword":"sample string 4","FirstName":"sample string 5","LastName":"sample string 6","ReceiveNewsletter":true,"FilterIDs":[1,2]}

application/xml, text/xml

Sample:
<RequestUsersSignup xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/YogaStreamAPIv2">
  <AppleToken>sample string 2</AppleToken>
  <FacebookAccessToken>sample string 1</FacebookAccessToken>
  <FilterIDs xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </FilterIDs>
  <FirstName>sample string 5</FirstName>
  <LastName>sample string 6</LastName>
  <ReceiveNewsletter>true</ReceiveNewsletter>
  <UserEmail>sample string 3</UserEmail>
  <UserPassword>sample string 4</UserPassword>
</RequestUsersSignup>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'RequestUsersSignup'.

Response Information

Resource Description

Success
NameDescriptionTypeAdditional information
success

boolean

None.

Response Formats

application/json, text/json

Sample:
{
  "success": true
}

text/html

Sample:
{"success":true}

application/xml, text/xml

Sample:
<Success xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/YogaStreamAPIv2">
  <success>true</success>
</Success>