Case actions

Record on a case that a message was sent to the partner or advertiser

Records on a case that the person sent a message from their own email: the template used, the date sent (YYYY-MM-DD, not in the future), an optional recipient address and note. The subject recorded is the template's subject filled for the case. It is added to the case timeline. Requires the write scope and an idempotency key.

post/projects/{project_id}/outreach-records

Request

  • Base URL: https://adslighthouse.com/api/v1
  • URL: https://adslighthouse.com/api/v1/projects/{project_id}/outreach-records
  • Auth: HTTP bearer

Path parameters

project_idstring required

The project: its id, its brand domain (for example nike.example) or its exact project or brand name. Unknown or ambiguous references return not_found; call list_projects then.

Headers

Idempotency-Keystring required

A unique value you choose for this request, such as a UUID. Repeating the same key returns the first result instead of starting paid work again.

Request body

case_type'policy' | 'affiliate' required

policy for a case from list_policy_cases; affiliate for a non-compliant affiliate case from list_affiliate_findings.

case_idstring

The policy case id. Required when case_type is policy.

affiliate_idstring

The affiliate ID exactly as list_affiliate_findings returns it. Required when case_type is affiliate.

template_idstring required

The template id from list_outreach_templates.

sent_onstring required

YYYY-MM-DD in your time zone.

recipientstring
notestring

Response

Record on a case that a message was sent to the partner or advertiser

createdboolean required
event_idstring required
subjectstring required
request_idstring

Changes

No recorded changes to this operation across all 1 revision of this API.