solarOS Organization API

Organization API

Send a Contract for signature

Hourly quote agreements are refused before delivery (409 CONFLICT), including existing fixed agreements whose quote has become hourly. Send the public quote link for acceptance of the current hourly terms. Fixed agreements and change-order signing retain their existing behavior. Sends using deliveryMode EMAIL or HOSTED_SIGNING. The optional body may target signerId and include message.

/api/v1/contracts/{id}/send

Hourly quote agreements are refused before delivery (409 CONFLICT), including existing fixed agreements whose quote has become hourly. Send the public quote link for acceptance of the current hourly terms. Fixed agreements and change-order signing retain their existing behavior. Sends using deliveryMode EMAIL or HOSTED_SIGNING. The optional body may target signerId and include message.

Send a Contract for signature. Use an organization API key with contracts:send. Check the response envelope and meta.requestId before triggering dependent workflow steps.

Required scopes

contracts:sendIdempotency-Key required

Parameters

NameInTypeDescription
idrequiredpathstringContract identifier returned by the Organization API.

Request body

object
FieldTypeDescription
deliveryModeEMAIL | HOSTED_SIGNINGOptional unless marked required.
signerIdstringOptional unless marked required.
messagestring | nullOptional unless marked required.
sendcontractRequest
{
  "deliveryMode": "EMAIL",
  "message": "Please review and sign."
}

Responses

200

Contract send action envelope

#/components/schemas/OrgApiActionEnvelope

401

Missing or invalid organization API key

#/components/schemas/OrgApiError

402

Organization billing access or an endpoint-specific business quota denied the request

#/components/schemas/OrgApiError

403

Missing required scope: contracts:send

#/components/schemas/OrgApiError

429

Rate limit exceeded

#/components/schemas/OrgApiError

Errors

401 Missing or invalid organization API key402 Organization billing access or an endpoint-specific business quota denied the request403 Missing required scope: contracts:send429 Rate limit exceeded

Static examples

curl -X POST "$SOLAROS_BASE_URL/api/v1/contracts/$SOLAROS_CONTRACT/send" \
  -H "Authorization: Bearer $SOLAROS_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $SOLAROS_IDEMPOTENCY_KEY" \
  --data '{"deliveryMode":"EMAIL","message":"Please review and sign."}'