Profiles

Create profile

Changed on

Creates a new profile with a name, optional description, and color. Names are unique per team: a duplicate returns a 409 whose details.existingProfileId carries the id of the existing profile. Set externalId to your own tenant or client id to find the profile later without storing its Zernio id. A duplicate externalId returns the same kind of 409, with code profile_external_id_conflict. Send an Idempotency-Key header to make retries safe: a retried create with the same key and body replays the original 201 (same _id) instead of conflicting.

post/v1/profiles

Request

  • Base URL: https://zernio.com/api
  • URL: https://zernio.com/api/v1/profiles
  • Auth: HTTP bearer

Headers

Idempotency-Keystring

Optional client-generated unique key (e.g. a UUID) that makes retries safe. Same key + same body replays the original response; same key + different body → 422; key still processing → 409. A request cut off mid-handler (for example by a function timeout) can leave its key in progress, answering 409 until the key expires after 24 hours.

Request body

namestring required
descriptionstring
colorstring
timezonestring

IANA timezone new posts on this profile use when they name no timezone. Omit to keep UTC. An unknown name returns 400.

externalIdstring

Your own identifier for this profile, typically the id of the tenant or client it serves in your system (1 to 255 characters, trimmed). Unique among the profiles of the user who owns the profile: a duplicate returns 409 profile_external_id_conflict. Look a profile up by it with GET /v1/profiles?externalId=.

Example request

{
  "color": "#ffeda0",
  "timezone": "Europe/Istanbul",
  "externalId": "tenant_42"
}

Response

Created

messagestring

Changes

  • 27c96850cc66Revision changes
    • info

      added the new optional request property

    • info

      added the optional property / to the response with the status

  • f8c8f34fb41aRevision changes
    • warning

      added the new account enum value to the / response property for the response status