Update Account Profile

Update an account profile with explicit set/clear fields and optimistic version checks.

POST/api/v1/accounts/dispatch

Request

curl -X POST "<BASE_URL>/api/v1/accounts/dispatch" \
  -H "Authorization: Bearer <ACCESS_TOKEN>" \
  -H "X-CQRS-Action: UPDATE_ACCOUNT_PROFILE" \
  -H "Content-Type: application/json" \
  -d '{
    "account_id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
    "expected_version": 1,
    "patch": {}
  }'

Authorization

Minimum role: Sales repThe caller must hold this role or a higher one.
Action: UPDATE_ACCOUNT_PROFILE

Headers

AuthorizationstringRequired
Access token of the signed-in user, as a Bearer token. It identifies the user, their role and the workspace.
X-CQRS-ActionstringRequired
Names the command to run. Must be UPDATE_ACCOUNT_PROFILE for this endpoint.
Content-TypestringRequired
Always application/json.
X-Idempotency-KeystringOptional
A key you choose that is unique to this attempt. A command repeated with the same key is not applied a second time.
X-Correlation-IdstringOptional
Your own identifier for the request. Returned in the x-correlation-id response header; generated when you leave it out.

Request body

account_iduuidRequired
No description yet.
expected_versionintegerRequired
No description yet.
patchobjectRequired
No description yet.
15 child fields
- account_numberenum or objectOptional
  Explicit partial update: omission preserves, clear removes, set replaces.
  Allowed values
  unchanged
  clear
  Default
  unchanged
  1 child fields
  setstringRequired
  No description yet.
- annual_recurring_revenueenum or objectOptional
  Explicit partial update: omission preserves, clear removes, set replaces.
  Allowed values
  unchanged
  clear
  Default
  unchanged
  1 child fields
  setobjectRequired
  No description yet.
  2 child fields
  amountstring or numberRequired
  No description yet.
  currencyCodestringRequired
  No description yet.
- billing_addressenum or objectOptional
  Explicit partial update: omission preserves, clear removes, set replaces.
  Allowed values
  unchanged
  clear
  Default
  unchanged
  1 child fields
  setobjectRequired
  No description yet.
  6 child fields
  citystringRequired
  No description yet.
  isoCountryCodestringRequired
  No description yet.
  street1stringRequired
  No description yet.
  postalCodestring or nullOptional
  No description yet.
  stateProvincestring or nullOptional
  No description yet.
  street2string or nullOptional
  No description yet.
- descriptionenum or objectOptional
  Explicit partial update: omission preserves, clear removes, set replaces.
  Allowed values
  unchanged
  clear
  Default
  unchanged
  1 child fields
  setstringRequired
  No description yet.
- domainenum or objectOptional
  Explicit partial update: omission preserves, clear removes, set replaces.
  Allowed values
  unchanged
  clear
  Default
  unchanged
  1 child fields
  setstringRequired
  No description yet.
- employee_countenum or objectOptional
  Explicit partial update: omission preserves, clear removes, set replaces.
  Allowed values
  unchanged
  clear
  Default
  unchanged
  1 child fields
  setstringRequired
  No description yet.
- headquartersenum or objectOptional
  Explicit partial update: omission preserves, clear removes, set replaces.
  Allowed values
  unchanged
  clear
  Default
  unchanged
  1 child fields
  setstringRequired
  No description yet.
- industryenum or objectOptional
  Explicit partial update: omission preserves, clear removes, set replaces.
  Allowed values
  unchanged
  clear
  Default
  unchanged
  1 child fields
  setstringRequired
  No description yet.
- linkedin_urlenum or objectOptional
  Explicit partial update: omission preserves, clear removes, set replaces.
  Allowed values
  unchanged
  clear
  Default
  unchanged
  1 child fields
  setstringRequired
  No description yet.
- nameenum or objectOptional
  Explicit partial update: omission preserves, clear removes, set replaces.
  Allowed values
  unchanged
  clear
  Default
  unchanged
  1 child fields
  setstringRequired
  No description yet.
- phoneenum or objectOptional
  Explicit partial update: omission preserves, clear removes, set replaces.
  Allowed values
  unchanged
  clear
  Default
  unchanged
  1 child fields
  setstringRequired
  No description yet.
- shipping_addressenum or objectOptional
  Explicit partial update: omission preserves, clear removes, set replaces.
  Allowed values
  unchanged
  clear
  Default
  unchanged
  1 child fields
  setobjectRequired
  No description yet.
  6 child fields
  citystringRequired
  No description yet.
  isoCountryCodestringRequired
  No description yet.
  street1stringRequired
  No description yet.
  postalCodestring or nullOptional
  No description yet.
  stateProvincestring or nullOptional
  No description yet.
  street2string or nullOptional
  No description yet.
- ticker_symbolenum or objectOptional
  Explicit partial update: omission preserves, clear removes, set replaces.
  Allowed values
  unchanged
  clear
  Default
  unchanged
  1 child fields
  setstringRequired
  No description yet.
- twitter_handleenum or objectOptional
  Explicit partial update: omission preserves, clear removes, set replaces.
  Allowed values
  unchanged
  clear
  Default
  unchanged
  1 child fields
  setstringRequired
  No description yet.
- website_urlenum or objectOptional
  Explicit partial update: omission preserves, clear removes, set replaces.
  Allowed values
  unchanged
  clear
  Default
  unchanged
  1 child fields
  setstringRequired
  No description yet.

Response

Status 202. The command was applied. The body is the record as it stands after the command: a JSON object whose fields depend on the record.

Errors

Every error carries an HTTP status. Where it also carries a code, branch on the code, not on the message.

400X-CQRS-Action is missing or names a command this route does not accept. Send UPDATE_ACCOUNT_PROFILE.
400DOMAIN_ROUTINGThe body is not a valid command. Check the required fields and their types.
401The access token is missing, expired or not valid.
401L1_AUTHThe caller's role is below rep or the caller has no access to this record.
403L1_POLICYA business rule refused the command. The message names the rule.
409L1_VERSIONexpected_version is not the record's current version. Read the record again, then retry.
409L1_IDEMPOTENCYA command with this idempotency key was already applied.
409CONFLICTThe command would duplicate a record that must be unique.
500L3_COMMITThe command was valid but could not be saved.