Skip to content

Update profile

Updates the customer's name and preferences.

Needs the profile:write scope.

Call

  • Tool: update_profile
  • Scope: profile:write
  • Writes, and may change or remove what is there.
  • Acts on a store.

Arguments

Name Type Required Description
display_name string or null No
locale string or null No
{
  "type": "object",
  "properties": {
    "display_name": {
      "anyOf": [
        {
          "type": "string",
          "minLength": 1,
          "maxLength": 120
        },
        {
          "type": "null"
        }
      ]
    },
    "locale": {
      "anyOf": [
        {
          "type": "string",
          "minLength": 1,
          "maxLength": 35
        },
        {
          "type": "null"
        }
      ]
    }
  },
  "additionalProperties": false
}

Answer

Name Type Required Description
contacts array of object Yes
id string Yes
display_name string or null Yes
locale string or null Yes
country string or null Yes
created_at string or null Yes

The answer’s full shape is on its API reference page.

Type to search…

↑↓ navigate↵ selectEsc close