Profile

Create a new profile.

post/api/v1/profile

Request

  • Base URL
    https://api.intheloop.io
  • Auth
    API key in header Authorization

Headers

Loop-Workspace-Idstring

Workspace ID.

Authorizationstring

Authorization header.

X-Impersonate-Userstring

Impersonation header.

Request body

idstring

Resource id

namestring

Resource name or title

revisionstring

Resource revision

clientIdstring

Resource client id

$typestring required
contextType'Workspace' | 'Virtual' required

Defines whether a profile context is shared (workspace) or private (user).

isPublicboolean required

Indicates whether this profile is public (has identificators) or private.

companystring

Company associated with this profile.

companyIdstring

Id of the linked Company entity, or null if unlinked. The only company representation used by new profiles — resolve the display name via this id, it is never denormalized.

companyLinkManualboolean required

True when the Company link was set/cleared manually. A manual link is pinned: the domain auto-association job never re-links or switches it.

titlestring

Title associated with this profile.

weightnumber required

Usage weight (contact interaction frequency) for the current user on this profile.

Response

OK

idstring

Resource id

namestring

Resource name or title

revisionstring

Resource revision

clientIdstring

Resource client id

$typestring required
contextType'Workspace' | 'Virtual' required

Defines whether a profile context is shared (workspace) or private (user).

isPublicboolean required

Indicates whether this profile is public (has identificators) or private.

companystring

Company associated with this profile.

companyIdstring

Id of the linked Company entity, or null if unlinked. The only company representation used by new profiles — resolve the display name via this id, it is never denormalized.

companyLinkManualboolean required

True when the Company link was set/cleared manually. A manual link is pinned: the domain auto-association job never re-links or switches it.

titlestring

Title associated with this profile.

weightnumber required

Usage weight (contact interaction frequency) for the current user on this profile.

Changes

No recorded changes to this operation across all 1 revision of this API.