Skip to main content

Profiles

A profile is a Verlynk project. Most post, account, and analytics commands need a profile context.

Profile resolution order

  1. --profile-id on the command
  2. VERLYNK_PROFILE_ID environment variable
  3. Saved profile (profiles:use or login --profile-id)
  4. Auto-select if the org has one profile or a default
  5. Otherwise the CLI exits and lists available profiles

List profiles

verlynk profiles:list
verlynk profiles:list --include-over-limit
verlynk profiles:list --json
FlagDescription
--include-over-limitInclude profiles that are over plan limits
--jsonOutput raw JSON

Get a profile

verlynk profiles:get <profile-uuid>
verlynk profiles:get <profile-uuid> --json

Set the default profile

verlynk profiles:use <profile-uuid>

This writes the profile ID into your stored credentials.

Create a profile

verlynk profiles:create --name "Marketing Team"
verlynk profiles:create --name "Marketing Team" --description "Q3 campaigns" --json
FlagDescription
--nameProfile name (3–30 chars), required
--descriptionOptional description
--jsonOutput raw JSON

Update a profile

At least one of --name, --description, or --default is required.

verlynk profiles:update <profile-uuid> --name "Growth"
verlynk profiles:update <profile-uuid> --default
verlynk profiles:update <profile-uuid> --description "Updated" --json

Delete a profile

verlynk profiles:delete <profile-uuid> --yes
warning

Destructive commands require --yes / -y.

Next steps

  • Accounts — List connected channels for a profile
  • Posts — Create and schedule posts