User APIs
block-data

Update Block Request Recipients

Replace additional_email_recipients on an existing request.

Auth mirrors the cancellation-request endpoint: the requestor edits their own row, a Block Admin can edit anyone in the client. No status transition — recipients are metadata on the row, so the state machine is bypassed and we just write through.

patch/api/v1/block/requests/{request_id}/recipients

Request

  • Base URL: https://carbonarc.ai (the document declares no server; this is the origin it was published from)
  • URL: https://carbonarc.ai/api/v1/block/requests/{request_id}/recipients
  • Auth: OAuth 2 (authorization code, authorization URL authorize, token URL token)

Path parameters

request_idstring uuid required

Request body

additional_email_recipientsstring[]

Response

Successful Response

idstring uuid required
dataset_idstring required
lagstring nullable
cutstring nullable
labelstring nullable
internal_namestring nullable
core_sourcestring nullable
client_idstring uuid required
client_polaris_principal_missingboolean
client_namestring nullable
requestor_emailstring required
status'pending_block_admin' | 'pending_compliance' | 'pending_internal' | 'approved' | 'intake_pending' | 'provisioning' | 'provisioning_failed' | 'trial_pending' | 'trial_active' | 'contracted' | 'contract_expired' | 'request_cancelled' | 'trial_cancelled' | 'contract_cancelled' | 'block_cancelled' | 'rejected' required
internal_queue_step'accounts' | 'legal' | 'engineering' | 'complete'
rejection_source'client_block_admin' | 'client_compliance' | 'carbonarc_accounts' | 'carbonarc_legal' | 'carbonarc_engineering'
rejection_messagestring nullable
rejected_bystring nullable
trial_duration_monthsinteger required
annual_pricestring nullable
original_trial_duration_monthsinteger nullable
original_annual_pricestring nullable
additional_email_recipientsstring[]
use_casestring nullable
trial_start_datestring date-time nullable
trial_end_datestring date-time nullable
original_trial_start_datestring date-time nullable
original_trial_end_datestring date-time nullable
first_ingestion_atstring date-time nullable
trial_start_trigger'first_ingestion' | 'auto_start'
approved_by_block_adminstring nullable
approved_by_compliancestring nullable
approved_atstring date-time nullable
cancellation_requested_atstring date-time nullable
cancellation_requested_bystring nullable
cancellation_request_reasonstring nullable
created_atstring date-time required
updated_atstring date-time required

Changes

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