# Update a brand profile (same as PUT)

```http
PATCH https://secure.yoprint.com/v1/api/store/{team_slug}/customer/{hash_id}/profile/{id}
```

- API version: v1
- Operation ID: `v1_public_customer_profile_update_patch`
- Section: Customers › [Customer brand profiles](https://developer.yoprint.com/reference/customer-brand-profiles.md)
- Web page: https://developer.yoprint.com/reference/customer-brand-profiles/v1-customer-profile-update-patch/
- Authentication: `Authorization: Bearer YOUR_API_KEY`

Changes the fields you send and returns the profile. Documents that use the profile show the change. The profile's Ship From address is checked on every update, whether you send `address_id` or not: if it is no longer current, or the profile has none, send a current one.

`PUT` and `PATCH` check the same fields.

## Permission

Needs the Manage Customers permission ("Manage All" or "Manage Assigned to User"). Whether the customer is assigned to you is not checked.

## Business rules

- After a customer address used here is edited, it is replaced by a new address (see Update a customer address) and this check refuses the old one with 409. Send the new `address_id`.
- Customers synced from Shopify are read-only here: changes are refused with 422 `validation_error` "External customers are read-only. Manage changes from Shopify." System customers (`is_system: true`) are refused the same way ("System customer cannot be modified or deleted.").

## Path parameters

- `team_slug` (string, required): Your team slug, shown as Team ID next to your API key in Profile. Example `your-team`.
- `hash_id` (string, required): The customer's id (`id` from List customers or Create a customer). A hash id from an earlier answer; unique keys and document numbers (such as `PO0042`) don't work here. Example `EDhVUaC6jbLbed`.
- `id` (string, required): The brand profile's id (`id` from List a customer's brand profiles). A hash id from an earlier answer; unique keys and document numbers (such as `PO0042`) don't work here. Example `uAu3dAKIaHyAYk`.

## Request body

Content type `application/json`, required.

Fields:

- `address_id` (string, optional): A new Ship From address. Same rules as on create.
- `company_name` (string, optional)
- `email` (string, optional): The brand profile's email address, printed on documents.
- `media_id` (string, optional): Required when `use_custom_logo` is true. An uploaded file not attached to anything yet; an attached one is silently not used.
- `phone` (string, optional): The brand profile's phone number, printed on documents.
- `use_custom_logo` (boolean, optional)
- `website` (string, optional): The website address.

### Example request

```bash
curl -X PATCH 'https://secure.yoprint.com/v1/api/store/your-team/customer/EDhVUaC6jbLbed/profile/uAu3dAKIaHyAYk' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Accept: application/json' \
  -H 'X-Yoprint-Decimal-Format: exact-v1' \
  -H 'Content-Type: application/json' \
  -d '{
    "address_id": "KKhhlVobndGXEj",
    "company_name": "Northwind Apparel"
  }'
```

## Response

`200` Successful response.

Fields:

- `data` (object, required)
  - `address_id` (string | null, required): The Ship From address, or null for a profile that has none.
  - `company_name` (string | null, required)
  - `customer_id` (string, required)
  - `id` (string, required)
  - `is_primary` (boolean, required): New sales orders and quotes for the customer use the primary profile.
  - `trashed` (boolean, required)
  - `use_custom_logo` (boolean, required)
  - `address` (object | null, optional): The Ship From address (an address, as in Customer addresses, without `used_by_active_profile`), or null.
    - `address1` (string | null, required)
    - `id` (string, required)
    - `is_current_source` (boolean, required): False for deleted, replaced, Shopify or redacted addresses. Only current addresses can be picked for new documents or edited.
    - `is_primary` (boolean, required)
    - `label` (string | null, required)
    - `revision_number` (integer, required): Goes up by one on every saved change. Send it back as `base_revision_number` when updating the address to protect against concurrent edits.
    - `role` (string, required): `billing` or `shipping` for customer addresses.
    - `trashed` (boolean, required)
    - `address2` (string | null, optional)
    - `address_family_id` (string | null, optional): Shared by an address and the copies made when it was edited after use.
    - `city` (string | null, optional)
    - `copied_from_address_id` (string | null, optional)
    - `country` (string | null, optional)
    - `country_code` (string | null, optional)
    - `customer_id` (string, optional): Customer addresses only: the customer's id.
    - `external_type` (string | null, optional): `shopify` for an address synced from Shopify.
    - `hold_stock` (boolean, optional): Company locations only; false for customer addresses.
    - `is_default_warehouse` (boolean, optional): Company locations only; false for customer addresses.
    - `is_external` (boolean, optional): True for an address synced from Shopify; such addresses are read-only.
    - `nexus` (boolean, optional): Company locations only; false for customer addresses.
    - `note` (string | null, optional)
    - `owner_id` (string | null, optional): The owner's id: for a customer address, the customer's id (the same as `customer_id`).
    - `owner_type` (string, optional): `customer` for customer addresses. One of: `"customer"`, `"team"`, `"unknown"`.
    - `postal_can_validate` (boolean, optional)
    - `postal_is_valid` (boolean, optional)
    - `postal_validated` (boolean, optional): True once YoPrint has checked the address with its address validator. `postal_can_validate` says whether it could be checked and `postal_is_valid` gives the result. Any edit resets it to false.
    - `postcode` (string | null, optional)
    - `source` (string, optional): `customer` for customer addresses. One of: `"customer"`, `"company_location"`, `"custom"`, `"unknown"`.
    - `state` (string | null, optional)
    - `state_code` (string | null, optional)
    - `superseded_at` (string (date-time) | null, optional)
    - `superseded_by_address_id` (string | null, optional): Set on an old copy: the address that replaced it.
    - `used_by_active_profile` (boolean, optional): True when a brand profile uses it as Ship From. Sent on lists, reads, updates and customer answers; not on create or set-primary.
  - `email` (string | null, optional)
  - `logo` (object | null, optional): The newest logo file (a file, as in Customer files), or null.
    - `collection` (string, required): Customer files: `tax_exemption`, `internal_file` or `external_file`. Vendor files: `default`, `mockup` or `production_file`.
    - `created_at` (string (date-time), required)
    - `file_name` (string, required)
    - `id` (string, required)
    - `mime_type` (string | null, required)
    - `name` (string | null, required): The display name.
    - `size` (integer, required): Bytes.
    - `custom_properties` (object | array, optional)
    - `customer_id` (string, optional): Customer files only.
    - `dimensions` (object | null, optional): Pixel size of an image, read from its header; null for other files and for images uploaded before the size was recorded.
      - `height` (integer, optional)
      - `width` (integer, optional)
    - `is_image` (boolean, optional)
    - `position` (integer | null, optional): Where the file sorts.
    - `preview` (object | null, optional): Preview image links `small`, `medium` and `large` (250, 800 and 1200 px), or null when there is no preview.
    - `preview_state` (string, optional): `ready`: the preview links work. `processing`: an image over 10 MB whose stored preview a worker is still making (seconds); read the file again, or in the web app wait for `media.preview_state_changed` on the team channel. `too_large`: an image over 120 megapixels; it never gets a preview. `failed`: the worker gave up. `none`: not an image. One of: `"ready"`, `"processing"`, `"too_large"`, `"failed"`, `"none"`.
    - `show_in_pdf` (boolean | null, optional)
    - `source_media_id` (string | null, optional)
    - `url` (string | null, optional): Where to download the file.
    - `view_url` (string | null, optional): A signed link to view the file. It expires: read it fresh, and don't store it.
  - `phone` (string | null, optional)
  - `website` (string | null, optional)
- `status` (integer, required)
- `success` (boolean, required)

Example response:

```json
{
  "data": {
    "address": {
      "address1": "100 Example Street",
      "address2": "Suite 200",
      "address_family_id": null,
      "city": "Springfield",
      "copied_from_address_id": null,
      "country": "United States",
      "country_code": "US",
      "customer_id": "V4keXwwxMQyXw7",
      "external_type": null,
      "hold_stock": false,
      "id": "KKhhlVobndGXEj",
      "is_current_source": true,
      "is_default_warehouse": false,
      "is_external": false,
      "is_primary": true,
      "label": "Head office",
      "nexus": false,
      "note": null,
      "owner_id": "V4keXwwxMQyXw7",
      "owner_type": "customer",
      "postal_can_validate": false,
      "postal_is_valid": false,
      "postal_validated": false,
      "postcode": "62701",
      "revision_number": 1,
      "role": "billing",
      "source": "customer",
      "state": "Illinois",
      "state_code": "IL",
      "superseded_at": null,
      "superseded_by_address_id": null,
      "trashed": false
    },
    "address_id": "KKhhlVobndGXEj",
    "company_name": "Northwind Apparel",
    "customer_id": "V4keXwwxMQyXw7",
    "email": "alex@example.com",
    "id": "Sd836BkLvOWpuP",
    "is_primary": true,
    "logo": null,
    "phone": "+1 201 555 0123",
    "trashed": false,
    "use_custom_logo": false,
    "website": "https://example.com"
  },
  "status": 200,
  "success": true
}
```

## Errors

- `401` The API key is missing or wrong (`unauthenticated`).
- `403` You are not allowed to do this. `api_access_not_in_plan`: your team's plan doesn't include API access (Pro and above, with an active subscription or trial), so every request answers this until the team upgrades. When your role lacks the permission the operation needs, the body is only `{"message": "Insufficient Permission"}`. Other refusals use the error envelope, with `unauthorized` or `user_is_not_authorized`.
  - When: Your role has no Manage Customers permission. This 403 has a short body, `{"message": "Insufficient Permission"}`, with no `success` or `error`. Fix: Ask a team owner to give your role Manage Customers.
- `404` Not found. `page_not_found`: the team slug is unknown, you are not a member of the team, or an id in the path is not one of this team's. `code: null`, with a message that starts "No query results for": there is no record with that id.
  - When: No live brand profile with this id on the customer, or no customer with this id. `error.code` is null and `error.message` names the record type. Fix: Check the ids.
- `409` The Ship From address is an old copy replaced by an edit (`blocked_superseded_historical_address`; `current_address` is the copy to use), or it is deleted, synced or redacted (`blocked_external_or_compliance`; `current_address` is the same address, or null when the profile has none). Not the usual error envelope: `success: false`, `address_save_result` and `message` (the `save_mode`); no `status` or `error`.
  - When: The Ship From address, sent or saved, is deleted, replaced, synced or redacted, or the profile has none and you sent no `address_id` (`blocked_external_or_compliance` with `current_address: null`). Not the usual error envelope: `success: false`, `address_save_result`, `message`. Fix: Send `address_id` with a current address.
- `422` Validation failed, or the image was refused by the media rules: a mockup that is not an image a preview can be made of (`mockup_type_not_allowed`), or an image over a size limit (`image_not_allowed`), or a file that is a web page, a script or a program (`validation_failed` on `media`, or `upload_not_allowed`: "This type of file cannot be uploaded."); `error.message` is one sentence naming the limit.
  - When: The address is not this customer's billing address or a company location (`error.code` `invalid_profile_address`). Fix: Pick a valid Ship From address.
  - When: A field has the wrong type, `media_id` is missing while `use_custom_logo` is true, or an id is not the team's. `error.code` is `validation_failed`. Fix: Fix each field named in `error.fields`; its keys are field paths such as `contact.0.phone`.
  - When: The customer comes from Shopify, or is a system customer (`error.code` `validation_error`, with the reason in `error.message`). Fix: Change Shopify customers in Shopify. System customers cannot be changed.

## Notes

- A new logo (`media_id`) is added to the profile's files; the newest one is the `logo`.

## Related

- [Update a customer address](https://developer.yoprint.com/reference/customer-addresses/v1-customer-address-update.md): `PUT /v1/api/store/{team_slug}/customer/{hash_id}/address/{id}`