POST openapi/crm/centers/{centerId}/prospects
Authorization
Access to this endpoint is granted if all following conditions are true:
- Authenticated territory has access to center which matches identifier given in "centerId" uri parameter.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
centerId | globally unique identifier |
Required |
Body Parameters
PearsonEnglish.LearningServices.Wse.Models.Prospects.ProspectParametersName | Description | Type | Additional information |
---|---|---|---|
FirstName | string |
None. |
|
LastName | string |
None. |
|
string |
None. |
||
Password | string |
None. |
|
CompanyId | globally unique identifier |
None. |
|
CenterId | globally unique identifier |
None. |
|
ShowPlacementResultFlag | boolean |
None. |
|
PhoneNumber | string |
None. |
|
IsB2bProspect | boolean |
None. |
|
Trial | PearsonEnglish.LearningServices.Wse.Models.Prospects.ProspectTrialParameters |
None. |
|
PlacementTestEntryPoint | PearsonEnglish.LearningServices.Core.Models.Enums.PlacementTestEntryPoint |
None. |
Request Formats
application/json, text/json
Sample:
{ "FirstName": "sample string 1", "LastName": "sample string 2", "Email": "sample string 3", "Password": "sample string 4", "CompanyId": "d662e5de-a141-4dc3-b382-3ff0264de88d", "CenterId": "e5206511-b762-410a-ab0b-25eb0e4b2125", "ShowPlacementResultFlag": true, "PhoneNumber": "sample string 6", "IsB2bProspect": true, "Trial": { "Enabled": true, "StartDate": "2024-10-05T08:54:29.6764883+00:00", "EndDate": "2024-10-05T08:54:29.6764883+00:00", "CenterId": "14635ad6-0b61-47b0-ab65-d5ade5444fd2", "UnitNumber": 1, "OnboardingEnabled": true }, "PlacementTestEntryPoint": 0 }
Response Information
Resource Description
System.Web.Http.IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.