/members [POST]

Registers a new member to a specific World Singles site

For a full list of available fields, see Registration Fields.

Parameters

Client credentials:

  • client_id (string) [REQUIRED] - the pre-registered UUID that identifies your client app,
  • client_secret (string) [REQUIRED] - the base64 “secret” provided by World Singles when you registered your client app,
  • platform (string) [optional] - one of "app_android", "app_ios", or "web"; identifies the host platform for the client application which may be used in logging internally to help us understand behavior across platforms.

Profile attributes for the new member:

  • siteid (numeric) [REQUIRED] - the numeric id of the site to which the member is registering
  • gender (string) [REQUIRED] - member’s gender. “Male”|“Female”
  • genderpreference (string) [REQUIRED] - gender the member is looking for. “Male”|“Female”
  • dateofbirth (date) [REQUIRED] - member’s date of birth MM/DD/YYYY
  • username (string, max 100 chars) [REQUIRED] - Preferred username. Alphanumeric characters only.
  • password (string) [REQUIRED] - 4 character minimum
  • email (string, max 128 chars) [REQUIRED] - A valid email address
  • city (string, max 255 chars) [see below] - member’s town/city
  • state (string, max 45 chars) [see below] - member’s state/region (full name)
  • zip (string, max 10 chars) [see below] - ZIP or postal code. Max 20 characters
  • country (string, max 5 chars) [see below] - A valid 2 letter country code. E.g. “US”, “GB”, “FR”
  • latitude (numeric) [see below] - member’s latitude from location services
  • longitude (numeric) [see below] - member’s longitude from location services
  • firstname (string, max 100 chars) [optional] - member’s first name (given name)
  • lastname (string, max 100 chars) [optional] - member’s last name (surname)
  • affiliateid (string, max 100 chars) [optional] - affiliate ID string if set in client cookie (see /recordaffiliatehit)
  • subid (string, max 100 chars) [optional] - subaffiliate ID string if set in client cookie / passed in URL

Geolocation fields:

  • We require either:
  • latitude and longitude or:
  • country and at least one of city, state, and/or zip

Response Messages

403 Forbidden

The possible failcode entries are:

  • 10001 - gender is not valid (not "Male" or "Female")
  • 10002 - genderpreference is not valid (not "Male" or "Female")
  • 10011 - country is not valid
  • 10021 - firstname is empty or too long (limit 100)
  • 10022 - lastname is empty or too long (limit 100)
  • 10031 - latitude is not a valid latitude
  • 10032 - longitude is not a valid longitude
  • 10041 - zip is empty or too long (limit 20)
  • 10051 - city is empty or too long (limit 255)
  • 10061 - state is empty or too long (limit 45)
  • 10101 - username already in use
  • 10102 - invalid username (contains illegal characters)
  • 10201 - password minimum length and/or other restrictions not met
  • 10301 - invalid email address (incorrect format)
  • 10302 - email address already in use
  • 10401 - invalid dateofbirth format
  • 10402 - minimum age requirement not met (dateofbirth)
  • 10501 - headline is empty or too long (over 75 characters)
  • 10601 - aboutme is empty or too long (over 1,500 characters)
  • 10701 - affiliate is suspended - call /recordaffiliatehit to obtain redirect URL
{ "fail" : "Invalid Argument", "failcode" : [ ... ] }

200 OK - success

The result is { user status information } with one additional field:

  • code - this is a short-lived authorization code that should be POSTed to the Authorization Server’s /token endpoint in order to obtain an access/refresh token pair for use with subsequent API calls

/members/self [POST]

Update specific attributes of the current member’s profile - protected.

Parameters

  • about_me (string) [optional] - update the member’s expanded profile description (changes to this field are moderated by Customer Service).
  • deactivated (boolean) [optional] - deactivate the member’s profile (true); you may also pass reason_id (numeric) [optional] which is an ID returned by GET /reasons/profile/delete. Note: once deactivated, future API calls will return 403 Deactivated. A member can reactivate their account by going through the login process again, where they will need to enter their credentials twice in order to confirm reinstatement of their profile.
  • display_name_preference (string) [optional] - how to display the member’s name. "nickname" | "firstname"
  • headline (string) [optional] - update the member’s brief profile description (changes to this field are moderated by Customer Service).
  • online (boolean) [optional] - update the member’s online status. true | false
  • searchable (boolean) [optional] - mark the member’s profile as hidden (false) or searchable (true).
  • world_plus (string) [optional]- update the member’s World+ status. "opted-in" | "opted-out" | "undecided"

NOTE 1: most of the registration and profile fields should be accepted by this API, in normalized form: lowercase, hyphenated or underscored, American-English spelling, e.g., best_attribute, education, eye-color, except for specific parameters listed above that replace them (such as world_plus instead of communityoptin) and “basic” registration fields, such as username, password, and the photo-related fields.

NOTE 2: the same rules apply here for the geolocation fields as apply for POST /members – either latitude/longitude are both provided or country and at least one of city, state, and/or zip are provided.

Response Message

403 Forbidden

The possible failcode entries are:

  • 10002 - genderpreference is not valid (not "Male" or "Female")
  • 10021 - first_name is empty or too long (limit 100)
  • 10022 - last_name is empty or too long (limit 100)
  • 10031 - latitude is not a valid latitude
  • 10032 - longitude is not a valid longitude
  • 10051 - city is empty or too long (limit 255)
  • 10101 - username already in use
  • 10102 - invalid username (contains illegal characters)
  • 10301 - invalid email address (incorrect format)
  • 10302 - email address already in use
  • 10501 - headline must be between 10 and 75 characters long
  • 10601 - about_me must be between 100 and 1500 characters long
  • 20101 - invalid value for gender
  • 20102 - member has exceeded allowable number of gender changes
  • 20201 - invalid value for country
  • 20301 - invalid value for zip (or zippostalcode)
  • 20401 - invalid dateofbirth (not a valid date value)
  • 20402 - member has exceeded allowed number of dateofbirth changes
  • 20403 - minimum age requirement not met
  • 20501 - email is not valid email address
  • 20502 - email is already in use on this site
  • 20701 - display_name_preference should be "nickname" or "firstname"
  • 20702 - online should be true or false
  • 20703 - world_plus should be "opted-in", "opted-out", or "undecided"
  • 20704 - deactivated should be true or false
  • 20801 - setting is not valid
  • 20901 - value(s) provided are out of range (for the parameter’s expected list of values)
{ "fail" : "Invalid Argument", "failcode" : [ ... ] }

200 OK - success

{ }