Create a referral source
/v1/referral-sourcesCreates a referral source and returns it. Send an Idempotency-Key header to make the request safe to retry. Available to keys belonging to office staff. Requires a key with write scope.
Headers
A unique value (a UUID works well) that makes this request safe to retry for 24 hours. A retry with the same key and body returns the first result; the same key with a different body is refused with idempotency_conflict.
Request body
application/jsonName of the source.
Kind of source, such as Hospital or Physician.
Organization the contact works for.
Main contact.
Contact's job title.
Contact's phone number.
Contact's email address.
Street address.
City.
State, as a two-letter code.
ZIP code.
Notes.
Whether you still receive referrals from this source.
Response
201The new referral source.
String representing the object's type. Always referral_source.
Unique identifier of the referral source.
Name of the source.
Kind of source, such as Hospital or Physician.
Organization the contact works for.
Main contact.
Contact's job title.
Contact's phone number.
Contact's email address.
Street address.
City.
State, as a two-letter code.
ZIP code.
Notes.
Whether you still receive referrals from this source.
Referrals received from this source.
Referrals from this source that became clients.
When the most recent referral arrived.
When the referral source was created.
When the referral source was last changed.
Response headers
Request-IdstringUnique ID of this request. Quote it when contacting support.RateLimit-LimitintegerRequests allowed in the current window.RateLimit-RemainingintegerRequests left in the current window.RateLimit-ResetintegerSeconds until the window resets.Idempotent-ReplayedstringPresent and true when this response is the stored result of an earlier request with the same Idempotency-Key.Errors
| Status | Code | Meaning |
|---|---|---|
| 400 | n/a | The request was malformed, a value was invalid, or it contained an unknown field (invalid_request, unknown_field). |
| 401 | n/a | The API key is missing, malformed, expired or revoked (unauthorized). |
| 403 | n/a | The key is read-only (insufficient_scope), or its user's role cannot do this (forbidden). |
| 409 | n/a | The Idempotency-Key was already used with a different request, or that request is still running (idempotency_conflict). |
| 429 | n/a | Too many requests (rate_limited). Wait for Retry-After seconds. |
| 500 | n/a | Something went wrong on our side (internal_error). Retry, and quote the request ID if it persists. |
Every error uses the same body. See Errors for the full list of codes.