Members
Partners

Create a member. Roles: partner admin.

Create a member and optionally send an invitation email.

Notes:

  • memberNumber is deprecated and replaced by username.
  • username is dependent on your organization's configuration.
    • It must be unique across the organization.
    • Some organizations will use email address, others will have a Member ID or other identifier.
    • Contact <a href="mailto:support@newstartmobile.com">support@newstartmobile.com</a> if you are unsure of the usage for your organization.
  • externalId should be included if you are the Identity Provider (IdP).
    • It must be unique across the organization.
    • This is typically the Member or User ID in your system.
    • Contact <a href="mailto:support@newstartmobile.com">support@newstartmobile.com</a> if you are unsure of the usage for your organization.
  • phone (optional) assumes US unless country code is included.
  • birthDate (optional) should use ISO-8601 yyyy-MM-dd format.
  • idpTypeCode (optional) identity provider type code
    • Only used when orgs have more than one identity provider (IdP) configured.
    • Contact <a href="mailto:support@newstartmobile.com">support@newstartmobile.com</a> if you are unsure of the usage for your organization.
  • If you would like an invitation email to be sent to the user:
    • Set sendInvitation: true
    • Provide an invitationContext which is included in the email:
      • "...you have been invited to {orgName} for {invitationContext}"
      • E.g. "you have been invited to Tigers Academy for Coaching 101 Training"
        • invitationContext: "Coaching 101 Training"
  • You can set responses to profile questions (custom attributes) by specifying a questionId or externalReferenceId for each question.
post/api/partners/orgs/{orgId}/members

Path parameters

orgIdinteger required

Request body

firstNamestring required
middleNamestring
lastNamestring required
phonestring
birthDatestring date
emailstring required
usernamestring
memberNumberstring
idpTypeCode'ABUSE_PREVENTION_SYSTEMS' | 'CLASSMARKER' | 'FINALSITE' | 'GAMEPLAN' | 'I9_SPORTS' | 'JDP' | 'LEAGUEAPPS' | 'LEAGUEAPPS_IDP' | 'LEAGUEAPPS_MLB' | 'MOBILE_COACH' | 'NCGA' | 'NCSI' | 'OPTOJUMP' | 'RAPSODO' | 'SAFESPORT' | 'SALESFORCE' | 'SAML_TEST_ID' | 'SPORT_80' | 'SPORTSENGINE' | 'STERLING' | 'ULTIMATE' | 'USA_FENCING' | 'USA_LACROSSE' | 'USA_LACROSSE_SAML' | 'USA_WRESTLING' | 'US_SAILING' | 'US_SKI_AND_SNOWBOARD' | 'US_SPORTS_CAMPS' | 'USSA' | 'USTA' | 'WEBPOINT' | 'WEBPOINT_OAUTH' | 'WORDPRESS'
externalIdstring
sendInvitationEmailboolean
invitationContextstring

Response

OK

Changes

Changed in 1 of the 2 revisions of this API.5

    • added the optional property / to the response with the status

      response-optional-property-added

    • added the optional property / to the response with the status

      response-optional-property-added

    • added the optional property / to the response with the status

      response-optional-property-added

    • added the optional property / to the response with the status

      response-optional-property-added

    • added the optional property / to the response with the status

      response-optional-property-added