Profiles
Rename Profile
Renames a profile. Its accounts stay filed under it. Filters that name the profile must use the new name from then on.
PATCH
Bearerheader
AuthorizationBearer <op_>Workspace API key, sent as Authorization: Bearer op_... Keys are created in the dashboard.
name*stringThe profile's name, URL-encoded. Letter case does not matter. For example, Client Team is sent as Client%20Team.
Length
1 <= length <= 60application/json- body
name*stringProfile name. It must be unique in the workspace, ignoring letter case. none is reserved.
Length
1 <= length <= 60Updated profile
application/json- response
name*stringThe profile's name. It identifies the profile and is unique in the workspace, ignoring letter case.
accountCount*integerConnected accounts filed under this profile.
createdAt*stringFormat
date-timeupdatedAt*stringFormat
date-timeExample Request
import { Configuration, ProfilesApi } from "@onepostly/sdk";const profilesApi = new ProfilesApi( new Configuration({ accessToken: process.env.ONEPOSTLY_API_KEY }));const response = await profilesApi.updateProfile({ name: "Business", updateProfileBody: { "name": "Acme Business" },});console.log(response);Example Response
{ "name": "Acme Business", "accountCount": 3, "createdAt": "2027-03-01T10:00:00.000Z", "updatedAt": "2027-03-15T10:00:00.000Z"}