Send a Salesforce record to CaseXchange as a new case or re-referral

curl --request POST \
  --url https://api.casexchange.com/api/public/v1/salesforce/interactive-sends \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "sourceRecordId": "<string>",
  "sfObjectApiName": "<string>",
  "targetFirmIds": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "idempotencyKey": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "sfRecordTypeDevName": "<string>",
  "overrides": {},
  "mappingVersion": "<string>",
  "reRefer": false,
  "notes": "<string>",
  "routingRuleId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "roundRobinPosition": 1
}
'

import requests

url = "https://api.casexchange.com/api/public/v1/salesforce/interactive-sends"

payload = {
    "sourceRecordId": "<string>",
    "sfObjectApiName": "<string>",
    "targetFirmIds": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
    "idempotencyKey": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "sfRecordTypeDevName": "<string>",
    "overrides": {},
    "mappingVersion": "<string>",
    "reRefer": False,
    "notes": "<string>",
    "routingRuleId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "roundRobinPosition": 1
}
headers = {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    sourceRecordId: '<string>',
    sfObjectApiName: '<string>',
    targetFirmIds: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
    idempotencyKey: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    sfRecordTypeDevName: '<string>',
    overrides: {},
    mappingVersion: '<string>',
    reRefer: false,
    notes: '<string>',
    routingRuleId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    roundRobinPosition: 1
  })
};

fetch('https://api.casexchange.com/api/public/v1/salesforce/interactive-sends', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.casexchange.com/api/public/v1/salesforce/interactive-sends",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'sourceRecordId' => '<string>',
    'sfObjectApiName' => '<string>',
    'targetFirmIds' => [
        '3c90c3cc-0d44-4b50-8888-8dd25736052a'
    ],
    'idempotencyKey' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'sfRecordTypeDevName' => '<string>',
    'overrides' => [
        
    ],
    'mappingVersion' => '<string>',
    'reRefer' => false,
    'notes' => '<string>',
    'routingRuleId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'roundRobinPosition' => 1
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.casexchange.com/api/public/v1/salesforce/interactive-sends"

	payload := strings.NewReader("{\n  \"sourceRecordId\": \"<string>\",\n  \"sfObjectApiName\": \"<string>\",\n  \"targetFirmIds\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ],\n  \"idempotencyKey\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"sfRecordTypeDevName\": \"<string>\",\n  \"overrides\": {},\n  \"mappingVersion\": \"<string>\",\n  \"reRefer\": false,\n  \"notes\": \"<string>\",\n  \"routingRuleId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"roundRobinPosition\": 1\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-API-Key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.casexchange.com/api/public/v1/salesforce/interactive-sends")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"sourceRecordId\": \"<string>\",\n  \"sfObjectApiName\": \"<string>\",\n  \"targetFirmIds\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ],\n  \"idempotencyKey\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"sfRecordTypeDevName\": \"<string>\",\n  \"overrides\": {},\n  \"mappingVersion\": \"<string>\",\n  \"reRefer\": false,\n  \"notes\": \"<string>\",\n  \"routingRuleId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"roundRobinPosition\": 1\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.casexchange.com/api/public/v1/salesforce/interactive-sends")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"sourceRecordId\": \"<string>\",\n  \"sfObjectApiName\": \"<string>\",\n  \"targetFirmIds\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ],\n  \"idempotencyKey\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"sfRecordTypeDevName\": \"<string>\",\n  \"overrides\": {},\n  \"mappingVersion\": \"<string>\",\n  \"reRefer\": false,\n  \"notes\": \"<string>\",\n  \"routingRuleId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"roundRobinPosition\": 1\n}"

response = http.request(request)
puts response.read_body

{
  "data": {
    "attempt": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "idempotencyKey": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "replay": true
    },
    "sentCase": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "referenceNumber": "ABC-0001",
      "salesforceId": "<string>",
      "salesforceObjectType": "<string>",
      "title": "<string>",
      "description": "<string>",
      "caseType": "<string>",
      "jurisdiction": "<string>",
      "county": "<string>",
      "clientFirstName": "<string>",
      "clientLastName": "<string>",
      "clientEmail": "jsmith@example.com",
      "clientPhone": "<string>",
      "clientDateOfBirth": "2023-12-25",
      "incidentDate": "2023-12-25",
      "tier": 123,
      "source": "<string>",
      "status": "<string>",
      "closingStatus": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "referrals": [
        {}
      ]
    }
  },
  "meta": {
    "requestId": "req_f2dbe1d3f6ad4a7bb5b4c9f2",
    "timestamp": "2023-11-07T05:31:56Z"
  }
}

{
  "data": {
    "attempt": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "idempotencyKey": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "replay": true
    },
    "sentCase": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "referenceNumber": "ABC-0001",
      "salesforceId": "<string>",
      "salesforceObjectType": "<string>",
      "title": "<string>",
      "description": "<string>",
      "caseType": "<string>",
      "jurisdiction": "<string>",
      "county": "<string>",
      "clientFirstName": "<string>",
      "clientLastName": "<string>",
      "clientEmail": "jsmith@example.com",
      "clientPhone": "<string>",
      "clientDateOfBirth": "2023-12-25",
      "incidentDate": "2023-12-25",
      "tier": 123,
      "source": "<string>",
      "status": "<string>",
      "closingStatus": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "referrals": [
        {}
      ]
    }
  },
  "meta": {
    "requestId": "req_f2dbe1d3f6ad4a7bb5b4c9f2",
    "timestamp": "2023-11-07T05:31:56Z"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>"
  },
  "meta": {
    "requestId": "req_f2dbe1d3f6ad4a7bb5b4c9f2",
    "timestamp": "2023-11-07T05:31:56Z"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>"
  },
  "meta": {
    "requestId": "req_f2dbe1d3f6ad4a7bb5b4c9f2",
    "timestamp": "2023-11-07T05:31:56Z"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>"
  },
  "meta": {
    "requestId": "req_f2dbe1d3f6ad4a7bb5b4c9f2",
    "timestamp": "2023-11-07T05:31:56Z"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>"
  },
  "meta": {
    "requestId": "req_f2dbe1d3f6ad4a7bb5b4c9f2",
    "timestamp": "2023-11-07T05:31:56Z"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>"
  },
  "meta": {
    "requestId": "req_f2dbe1d3f6ad4a7bb5b4c9f2",
    "timestamp": "2023-11-07T05:31:56Z"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>"
  },
  "meta": {
    "requestId": "req_f2dbe1d3f6ad4a7bb5b4c9f2",
    "timestamp": "2023-11-07T05:31:56Z"
  }
}

Salesforce

Send a Salesforce record to CaseXchange as a new case or re-referral

Turns an org-side “send this record to CaseXchange” submit into a durable, idempotent CaseXchange case creation (or re-referral to a new firm) — spec §7.2. Reads the source record from Salesforce using the firm’s active, activated, interactive-send-enabled v2 sending profile, applies its confirmed prefill links plus any overrides, and creates (or re-refers) a case.

Idempotency: pass a fresh idempotencyKey (UUID) on every distinct submit. Replaying the same key returns the original outcome with 200 and attempt.replay: true instead of creating a duplicate case; a genuinely new submit must use a new key.

Observing write-back: there is NO status-check endpoint. Once this call returns, the CaseXchange case exists, but its bridge fields (match key, status, reference number, deep link) are stamped back onto the source Salesforce record asynchronously by the write-back job — observe completion by reading those fields on the source record (typically within ~5 minutes). A send that exhausts its write-back retries moves to needs_attention and is paused for an admin; that state sends NO signal to the org side, so clients should surface a send whose fields remain unstamped after a timeout as stale rather than wait indefinitely.

Error codes (409s carry a per-code error.details object — see the 409 response):

400 unsupported_match_key_mode — the resolved sending profile does not use an external-ID match key (send is not supported).
400 validation_error — the built create payload failed validation; error.details.errors carries the field-level issues.
400 bad_request — a re-refer business-rule rejection propagated from the re-referral service (e.g. the case is not in a re-referable status, or no prior referral exists); the message is descriptive.
404 send_mapping_not_configured — no active, activated, interactive-send-enabled v2 sending profile matches the given object/record type.
404 source_record_not_found — sourceRecordId does not exist (or is not visible) in Salesforce.
404 linked_case_not_found — reRefer was requested but no linked CaseXchange case exists for this record (or it no longer exists).
409 record_already_sent — the record is already linked to a CaseXchange case and reRefer was not requested. error.details: { baseCaseId, referenceNumber } (the existing case, so the client can offer re-refer).
409 record_already_linked — the record already carries a match-key value from a prior send with no active link. error.details: { matchKeyValue }.
409 send_in_progress — a send for this record (or idempotency key) is already in flight. error.details: { retryAfterMs } — the remaining in-flight window (floored at 0) to back off before retrying.
409 attempt_failed — a previous send with this idempotency key failed; submit a fresh key to retry. error.details: { failureCode, lastError }.
502 salesforce_unavailable — no usable Salesforce access token for this connection.
502 salesforce_read_failed — the Salesforce SOQL read of the source record failed.

Requires FULL tier.

POST

salesforce

interactive-sends

Send a Salesforce record to CaseXchange as a new case or re-referral

curl --request POST \
  --url https://api.casexchange.com/api/public/v1/salesforce/interactive-sends \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "sourceRecordId": "<string>",
  "sfObjectApiName": "<string>",
  "targetFirmIds": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "idempotencyKey": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "sfRecordTypeDevName": "<string>",
  "overrides": {},
  "mappingVersion": "<string>",
  "reRefer": false,
  "notes": "<string>",
  "routingRuleId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "roundRobinPosition": 1
}
'

import requests

url = "https://api.casexchange.com/api/public/v1/salesforce/interactive-sends"

payload = {
    "sourceRecordId": "<string>",
    "sfObjectApiName": "<string>",
    "targetFirmIds": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
    "idempotencyKey": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "sfRecordTypeDevName": "<string>",
    "overrides": {},
    "mappingVersion": "<string>",
    "reRefer": False,
    "notes": "<string>",
    "routingRuleId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "roundRobinPosition": 1
}
headers = {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    sourceRecordId: '<string>',
    sfObjectApiName: '<string>',
    targetFirmIds: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
    idempotencyKey: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    sfRecordTypeDevName: '<string>',
    overrides: {},
    mappingVersion: '<string>',
    reRefer: false,
    notes: '<string>',
    routingRuleId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    roundRobinPosition: 1
  })
};

fetch('https://api.casexchange.com/api/public/v1/salesforce/interactive-sends', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.casexchange.com/api/public/v1/salesforce/interactive-sends",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'sourceRecordId' => '<string>',
    'sfObjectApiName' => '<string>',
    'targetFirmIds' => [
        '3c90c3cc-0d44-4b50-8888-8dd25736052a'
    ],
    'idempotencyKey' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'sfRecordTypeDevName' => '<string>',
    'overrides' => [
        
    ],
    'mappingVersion' => '<string>',
    'reRefer' => false,
    'notes' => '<string>',
    'routingRuleId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'roundRobinPosition' => 1
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.casexchange.com/api/public/v1/salesforce/interactive-sends"

	payload := strings.NewReader("{\n  \"sourceRecordId\": \"<string>\",\n  \"sfObjectApiName\": \"<string>\",\n  \"targetFirmIds\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ],\n  \"idempotencyKey\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"sfRecordTypeDevName\": \"<string>\",\n  \"overrides\": {},\n  \"mappingVersion\": \"<string>\",\n  \"reRefer\": false,\n  \"notes\": \"<string>\",\n  \"routingRuleId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"roundRobinPosition\": 1\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-API-Key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.casexchange.com/api/public/v1/salesforce/interactive-sends")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"sourceRecordId\": \"<string>\",\n  \"sfObjectApiName\": \"<string>\",\n  \"targetFirmIds\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ],\n  \"idempotencyKey\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"sfRecordTypeDevName\": \"<string>\",\n  \"overrides\": {},\n  \"mappingVersion\": \"<string>\",\n  \"reRefer\": false,\n  \"notes\": \"<string>\",\n  \"routingRuleId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"roundRobinPosition\": 1\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.casexchange.com/api/public/v1/salesforce/interactive-sends")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"sourceRecordId\": \"<string>\",\n  \"sfObjectApiName\": \"<string>\",\n  \"targetFirmIds\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ],\n  \"idempotencyKey\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"sfRecordTypeDevName\": \"<string>\",\n  \"overrides\": {},\n  \"mappingVersion\": \"<string>\",\n  \"reRefer\": false,\n  \"notes\": \"<string>\",\n  \"routingRuleId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"roundRobinPosition\": 1\n}"

response = http.request(request)
puts response.read_body

{
  "data": {
    "attempt": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "idempotencyKey": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "replay": true
    },
    "sentCase": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "referenceNumber": "ABC-0001",
      "salesforceId": "<string>",
      "salesforceObjectType": "<string>",
      "title": "<string>",
      "description": "<string>",
      "caseType": "<string>",
      "jurisdiction": "<string>",
      "county": "<string>",
      "clientFirstName": "<string>",
      "clientLastName": "<string>",
      "clientEmail": "jsmith@example.com",
      "clientPhone": "<string>",
      "clientDateOfBirth": "2023-12-25",
      "incidentDate": "2023-12-25",
      "tier": 123,
      "source": "<string>",
      "status": "<string>",
      "closingStatus": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "referrals": [
        {}
      ]
    }
  },
  "meta": {
    "requestId": "req_f2dbe1d3f6ad4a7bb5b4c9f2",
    "timestamp": "2023-11-07T05:31:56Z"
  }
}

{
  "data": {
    "attempt": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "idempotencyKey": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "replay": true
    },
    "sentCase": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "referenceNumber": "ABC-0001",
      "salesforceId": "<string>",
      "salesforceObjectType": "<string>",
      "title": "<string>",
      "description": "<string>",
      "caseType": "<string>",
      "jurisdiction": "<string>",
      "county": "<string>",
      "clientFirstName": "<string>",
      "clientLastName": "<string>",
      "clientEmail": "jsmith@example.com",
      "clientPhone": "<string>",
      "clientDateOfBirth": "2023-12-25",
      "incidentDate": "2023-12-25",
      "tier": 123,
      "source": "<string>",
      "status": "<string>",
      "closingStatus": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "referrals": [
        {}
      ]
    }
  },
  "meta": {
    "requestId": "req_f2dbe1d3f6ad4a7bb5b4c9f2",
    "timestamp": "2023-11-07T05:31:56Z"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>"
  },
  "meta": {
    "requestId": "req_f2dbe1d3f6ad4a7bb5b4c9f2",
    "timestamp": "2023-11-07T05:31:56Z"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>"
  },
  "meta": {
    "requestId": "req_f2dbe1d3f6ad4a7bb5b4c9f2",
    "timestamp": "2023-11-07T05:31:56Z"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>"
  },
  "meta": {
    "requestId": "req_f2dbe1d3f6ad4a7bb5b4c9f2",
    "timestamp": "2023-11-07T05:31:56Z"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>"
  },
  "meta": {
    "requestId": "req_f2dbe1d3f6ad4a7bb5b4c9f2",
    "timestamp": "2023-11-07T05:31:56Z"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>"
  },
  "meta": {
    "requestId": "req_f2dbe1d3f6ad4a7bb5b4c9f2",
    "timestamp": "2023-11-07T05:31:56Z"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>"
  },
  "meta": {
    "requestId": "req_f2dbe1d3f6ad4a7bb5b4c9f2",
    "timestamp": "2023-11-07T05:31:56Z"
  }
}

Authorizations

X-API-Key

string

header

required

Public API key (starts with cxp_). Required on every request.

Body

application/json

sourceRecordId

string

required

Salesforce record Id (15 or 18 char) of the source record being sent.

Pattern: ^[a-zA-Z0-9]{15,18}$

sfObjectApiName

string

required

Salesforce object API name, e.g. litify_pm__Matter__c.

targetFirmIds

string<uuid>[]

required

Receiving firm id(s) for this send. Array-shaped for forward compatibility, but CaseXchange supports exactly one active referral per case — exactly one target firm per send today.

Required array length: 1 element

idempotencyKey

string<uuid>

required

A fresh UUID generated by the caller for each distinct submit. Replaying the same key returns the original outcome (200, attempt.replay: true) instead of creating a duplicate case.

sfRecordTypeDevName

string | null

Record type developer name. Omit or null to match profiles with no record type set.

overrides

object

Optional per-field overrides keyed by casex.* canonical key. Keys must be one of the interactive-send form fields returned by GET /salesforce/send-mapping (sendFields).

Show child attributes

mappingVersion

string

Observability only, echoed from GET /salesforce/send-mapping. A stale/mismatched value is logged but never rejected — the server always re-reads current mapping config.

Maximum string length: 64

reRefer

boolean

default:false

When true and the source record is already linked to a CaseXchange case, re-refer that case to targetFirmIds instead of creating a new case.

notes

string

Maximum string length: 10000

routingRuleId

string<uuid>

Optional. Routing rule this send was chosen from (from GET /routing/evaluate). Ignored (with a server-side warning) if it is not a live rule owned by your firm.

roundRobinPosition

integer

Optional. The roundRobinPosition from GET /routing/evaluate. Requires routingRuleId; advances the rule's round-robin pointer.

Required range: x >= 0

Response

Replay of a previously processed idempotency key — returns the original outcome

data

object

required

Result of a durable, idempotent interactive send/re-refer (spec §7.2). attempt.state tells the org client where write-back stands: 'writeback_pending' means the bridge fields will be stamped by the writeback job; 'completed' means they already have been. 'superseded' (terminal, returned on replay) means a later re-refer superseded this attempt's referral, so nothing is left to stamp. There is no status-check endpoint: the only signal that write-back finished is the bridge fields appearing on the source Salesforce record (typically within ~5 minutes). A send that exhausts its retries becomes 'needs_attention' and is paused for an admin WITHOUT signalling the org, so clients should treat a still-unstamped record after a timeout as stale rather than poll indefinitely.

Show child attributes

Reference Data

Firms

Cases

Documents

Users

Sent Cases

Routing

Analytics

Notifications

Med Cases

MedEx Documents

Import

Salesforce

Send a Salesforce record to CaseXchange as a new case or re-referral

Authorizations

Body

Response