Other

POST /v1/prospects/{prospect_id}/outreach/preview

POST /v1/prospects/{prospect_id}/outreach/preview

Required scopes: prospects:read, communications:read

post/v1/prospects/{prospect_id}/outreach/preview

Request

  • Base URL: https://api.yardstick.team
  • URL: https://api.yardstick.team/v1/prospects/{prospect_id}/outreach/preview
  • Auth: HTTP bearer

Headers

Idempotency-Keystring

Supported for safe retry. Reuse the same key to receive the cached response without repeating the operation.

X-Request-Idstring

Optional caller-supplied request identifier. Values must match ^[A-Za-z0-9_-]{1,128}$; a valid value is echoed in the response X-Request-Id header, otherwise the API generates one.

Request body

job_posting_idstring nullable
subjectstring nullable
bodystring nullable
personalization_instructionstring nullable
outreach_intent_keystring nullable

Response

Success

object required

Changes

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