Create profile
Creates a new profile inside the workspace behind your API key. You can optionally set the hosted Connect branding fields in the same call.
Authorization
AuthorizationBearer <token>In header
Workspace API key.
Request Body
namestring
Unique profile name inside the workspace.
branding_logo_url?string
Optional HTTPS logo URL for hosted Connect.
branding_display_name?string
Optional hosted Connect display name.
branding_primary_color?string
Optional hex color such as #10b981.
branding_hide_powered_by?boolean
Optional. Hides the footer attribution on hosted Connect. Growth / Team only.
Response Body
201
idstring
Profile ID.
workspace_idstring
Owning workspace ID.
namestring
Profile name.
account_countnumber
Connected account count. New profiles start at 0.
branding_logo_urlstring | null
Stored hosted Connect logo URL.
branding_display_namestring | null
Stored hosted Connect display name.
branding_primary_colorstring | null
Stored hosted Connect brand color.
branding_hide_powered_byboolean
Whether hosted Connect hides the footer attribution for this profile.
401
error.codestring
Common values include "UNAUTHORIZED", "VALIDATION_ERROR", and "PROFILE_NAME_TAKEN".
error.normalized_codestring
Lowercase alias such as "profile_name_taken".
error.messagestring
Human-readable error message.
request_idstring
Request identifier for debugging and support.
409
error.codestring
Common values include "UNAUTHORIZED", "VALIDATION_ERROR", and "PROFILE_NAME_TAKEN".
error.normalized_codestring
Lowercase alias such as "profile_name_taken".
error.messagestring
Human-readable error message.
request_idstring
Request identifier for debugging and support.
422
error.codestring
Common values include "UNAUTHORIZED", "VALIDATION_ERROR", and "PROFILE_NAME_TAKEN".
error.normalized_codestring
Lowercase alias such as "profile_name_taken".
error.messagestring
Human-readable error message.
request_idstring
Request identifier for debugging and support.
500
error.codestring
Common values include "UNAUTHORIZED", "VALIDATION_ERROR", and "PROFILE_NAME_TAKEN".
error.normalized_codestring
Lowercase alias such as "profile_name_taken".
error.messagestring
Human-readable error message.
request_idstring
Request identifier for debugging and support.