/api/v1/collections/{id}/activity
Log a contact attempt against a delinquent account.
- Scope
collections:write- Rate limit
- 100 requests / min
- Idempotency
Idempotency-Keysupported
Authentication
Send your key as Authorization: Bearer …. It must carry the scope collections:write; a key without it receives 403 forbidden.
Path parameters
idstringrequiredHeaders
Idempotency-KeystringReplays the first response for a repeated request. Reusing a key with a different body is idempotency_key_reused (409), never a silent replay.
Request body
application/jsonrequiredtypestring (enum)requiredcallsmsemaillettervisitpromise_to_paydisputenoteoutcomestring (enum)requiredconnectedvoicemailno_answerpromise_to_paybroken_promisedisputerefusedpartial_paymentothernotesstringmax length 2000Refused parameters7
Sending any of these returns 400 validation_error naming the field. Each entry explains what to do instead.
next_action_date'next_action_date' is not accepted: logging an activity records the contact and stamps last_contact_date; it cannot schedule a follow-up. No endpoint sets next_action_date today.
performed_by'performed_by' is not accepted: an activity is always attributed to the API key that logged it.
performedBy'performedBy' is not accepted: an activity is always attributed to the API key that logged it.
performed_at'performed_at' is not accepted: the activity is timestamped when it is recorded.
collection_case_id'collection_case_id' is not accepted: the case is taken from the URL path.
case_id'case_id' is not accepted: the case is taken from the URL path.
result'result' is not accepted; the parameter is named 'outcome'.
Response
201application/jsonSerializedCollectionActivityidstringrequiredcollection_case_idstringrequiredtypestringrequiredOne of call, sms, email, letter, visit, promise_to_pay, dispute, note.
outcomestring | nullrequirednullableOne of connected, voicemail, no_answer, promise_to_pay,
broken_promise, dispute, other, or null. An outcome recorded as
refused or partial_payment is returned as other.
notesstring | nullrequirednullableAs stored, including the [outcome: …] marker when one was added.
performed_bystringrequiredapi_key:<key id> — the API key that recorded the activity. Not settable in the request.
performed_atstring | nullrequirednullableErrors
The statuses this operation can return, with the error.code values behind each. Every error body is the shared envelope described under Errors in Getting started.
400validation_error401unauthorized403forbidden404not_found409idempotency_key_reused429rate_limit_exceeded500internal_error