Other

PATCH /v1/prospects/{prospect_id}

PATCH /v1/prospects/{prospect_id}

Required scopes: prospects:write

patch/v1/prospects/{prospect_id}

Request

  • Base URL: https://api.yardstick.team
  • URL: https://api.yardstick.team/v1/prospects/{prospect_id}
  • 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

owner_user_idstring uuid nullable

Hand the prospect to another active member of this organization, or send null to leave it unowned. Omitting the field leaves the current owner exactly as it is — update never falls back to the key holder. A user who is not an active member of this organization is refused with 400 invalid_request_body. Changing the owner creates a handoff task in its own right, independently of next_follow_up_at, unless it is an unassignment, self-assignment, or the owner has no resolvable email. While a follow-up date is set, the separate “Follow up with …” task also moves to the new owner.

owner_handoff_notestring nullable

An optional note stored with the permanent owner-change timeline entry and shown with the recipient's handoff task when one is created. This field must accompany owner_user_id, including null for a documented unassignment.

relationship_status'active' | 'archived'
source_labelstring nullable
last_contacted_atstring nullable
last_reviewed_atstring nullable
next_follow_up_atstring nullable
next_follow_up_notestring nullable
archived_reasonstring nullable

Response

Success

object required

Changes

No recorded changes to this operation across all 2 revisions of this API.