solarOS Organization API

Organization API

Update one Customer Relationship

Updates relationship contact mirrors by relationship id. firstName, lastName, and phone change the shared Customer only when this organization alone holds that Customer and it has no portal account. Otherwise they are saved on this relationship, read back as displayName and phone, and the shared Customer and every other organization stay as they were. ownerTeamMemberId is create-only here and is rejected on PATCH because Organization API v1 does not expose the staff reassignment action. Required scope: customers:write.

/api/v1/customer-relationships/{id}

Updates relationship contact mirrors by relationship id. firstName, lastName, and phone change the shared Customer only when this organization alone holds that Customer and it has no portal account. Otherwise they are saved on this relationship, read back as displayName and phone, and the shared Customer and every other organization stay as they were. ownerTeamMemberId is create-only here and is rejected on PATCH because Organization API v1 does not expose the staff reassignment action. Required scope: customers:write.

Update one Customer Relationship. Use an organization API key with customers:write. Check the response envelope and meta.requestId before triggering dependent workflow steps.

Required scopes

customers:write

Parameters

NameInTypeDescription
idrequiredpathstringCustomer Relationship identifier returned by the Organization API.

Request body

objectrequired
FieldTypeDescription
customerSalesforceAccountIdstring | nullOptional unless marked required.
billingEmailstring | nullInvoice recipient for this organization. Blank or null uses the contact email.
emailstring | nullOptional unless marked required.
firstNamestring | nullOptional unless marked required.
lastNamestring | nullOptional unless marked required.
phonestring | nullOptional unless marked required.
updatecustomerrelationshipRequest
{
  "phone": "+15555550124"
}

Responses

200

Updated Customer Relationship envelope

#/components/schemas/OrgApiResourceEnvelope

400

Validation error

#/components/schemas/OrgApiError

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: customers:write

#/components/schemas/OrgApiError

404

Not found

#/components/schemas/OrgApiError

429

Rate limit exceeded

#/components/schemas/OrgApiError

Errors

400 Validation error401 Missing or invalid organization API key402 Organization billing access or an endpoint-specific business quota denied the request403 Missing required scope: customers:write404 Not found429 Rate limit exceeded

Static examples

curl -X PATCH "$SOLAROS_BASE_URL/api/v1/customer-relationships/$SOLAROS_CUSTOMER_RELATIONSHIP" \
  -H "Authorization: Bearer $SOLAROS_API_KEY" \
  -H "Content-Type: application/json" \
  --data '{"phone":"+15555550124"}'