API Reference

Social network credentials verification

post
https://{project_url}/webservice/rest-api/{api_interface}/{version}/customers/actions/verify-social-network-credentials

Verification of a customer account's social network credentials.

Validates a customer's social network token against their CareCloud account. Returns the customer ID if the credentials are valid. Use this endpoint to authenticate a customer who has linked a social network account to their CareCloud profile.

⚠️ Action method for verification credentials is available only in Enterprise API.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
social_network_credentials
object
required

This is the customer’s social media credentials.
Special Rule for PUT Request with social network credentials: Unlike typical HTTP PUT requests, the request will not erase existing data if parameters are missing. If you do not include the social media credentials in the PUT request, the existing credentials will remain unchanged.

Responses

error.error_data.invalid_params[] array lists the parameters that caused the failure, each carrying a reason code. See the BadRequestErrorBody schema for the generic reason taxonomy. Operations with domain-specific business rules document additional reasons at the operation level.

429

Too many requests - more than the resource limit.

503

Temporary state when the service is temporarily unavailable, overloaded or there is a maintenance window.

Updated 27 days ago

Did this page help you?
Language
Credentials
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 27 days ago

Did this page help you?