Edit Profile Fields

Update profile field values for an account.

PATCH https://api.sonorancms.com/v2/community/accounts/00000000-0000-0000-0000-000000000000/profile-fields

Rate limit: 22 requests per minute

Authenticated v2 endpoints are rate limited per credential rather than per IP address.

Update profile field values for an account.

Route Parameters

| Name | Type | Required | Description |

| --- | --- | --- | --- |

| accountId | string (uuid) | Yes | Target accountId. |

Request Body

| Name | Type | Required | Description |

| --- | --- | --- | --- |

| profileFields | array | Yes | See example request for the shape. |

Example Request

local Sonoran = require("sonoran")

local sonoran = Sonoran.createClient({
  product = Sonoran.productEnums.CMS,
  apiKey = "YOUR_API_KEY",
  communityId = "YOUR_COMMUNITY_ID",
  defaultServerId = 1,
  timeoutMs = 30000,
})

local accountId = "00000000-0000-0000-0000-000000000000"
local payload = {
  ["profileFields"] = {
    {
      ["id"] = "discord",
      ["value"] = "1234567890"
    }
  }
}

local response = sonoran.cms:editProfileFieldsV2(accountId, payload)

if response.success then
  print(response.data)
else
  print(response.reason)
end

Response

The data array is the updated profile field payload saved back onto the account. Each entry is just an { id, value } pair.

Last updated

Was this helpful?