Enroll or unenroll a lead
POST/services/apexrest/Outbound/Leads
One endpoint handles both actions. The action field inside data
selects the behaviour.
- enroll creates a lead record for your firm, or updates the record
we already hold for the same
External_System_Record_id. Returns 201. - unenroll records a stop-calling request and ends the calling cadence in the background. Returns 201, or 200 when the same lead was already stopped within the last 60 minutes.
Both actions are safe to retry. Retry on network errors, timeouts, 500 and 503. Do not retry a 400 or 401 without changing the request.
Signing. Serialize the JSON body to a string once, compute an
HMAC-SHA256 over that exact string using the shared secret we issued,
hex-encode it in lowercase, send it in x-auth-token, and send the same
string unchanged as the body. See
Authentication for
Node.js and Python examples.
The Send API Request panel cannot compute the signature for you, so a request sent from this page returns 401. Use the generated code samples as a starting point and add the signing step.
Request
Responses
- 200
- 201
- 400
- 401
- 500
- 503
Success. A repeat unenroll for a lead we already stopped within the last 60 minutes. Treat as handled.
Success. A lead was created or updated, or a stop-calling request was queued.
Bad request. Required information is missing or invalid. Correct the request; do not retry unchanged.
Not authorized. The firm name or signature is invalid. Check c-name, Law_Firm_Name, and your signature computation; do not retry unchanged.
Server error on our side. Retry after a short delay. Contact us if it persists.
The stop-calling service is temporarily unavailable. Enroll requests are unaffected. Retry the unenroll later.