Create Visit Request (CRM)
๐งพ Create Visit Request (CRM)
Endpoint: POST /api/v3/visits/request
Auth Required: โ Yes (Bearer Token)
๐ Description
Submits a new customer visit request on behalf of a CRM system user. This is typically used when syncing visit intents from Salesforce, Dynamics, or other external platforms into the Nexus scheduling system.
๐ Query Parameters
None.
๐ฅ Request Body
Content-Type: application/json
Submit visit request details as per the CreateCRMVisitDto
schema.
๐ง Sample Schema
{ "<visitField>": "<value>", "<anotherVisitField>": "<value>" }
๐ค Request Example
POST https://api.briefingedge.com/api/v3/visits/request Authorization: Bearer <token> Content-Type: application/json { "requestedBy": "crm-user@acme.com", "customerAccountId": 12345, "preferredDate": "2025-11-05" }
โ Success Response (200 OK)
Returns the created request or a status confirmation object.
Example:
{ "RequestID": 7890, "Status": "Pending Review", "SubmittedBy": "crm-user@acme.com" }
โ Error Responses
Code | Message | Description |
---|---|---|
400 | Bad Request | Missing or invalid request data. |
401 | Unauthorized | Missing or invalid bearer token. |
500 | Internal Server Error | Unexpected server-side failure. |