Profile

Perform a batch action (delete, export, removecompany) on a list of profiles. All profile IDs must belong to the same workspace and the list size is capped at MaxPageSize. Always returns a per-profile success/failure result; for Export, SignedLink additionally carries a time-limited download link to a CSV file built from the profiles the caller was allowed to export.

post/api/v1/profile/batch

Request

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

Headers

Authorizationstring

Authorization header.

X-Impersonate-Userstring

Impersonation header.

Request body

action'Delete' | 'RemoveCompany' required

Action to perform in a profile batch action request.

profileIdsstring[]

Profile IDs to perform the action on. All profiles must belong to the same workspace.

companyIdstring

Company ID. Required for the RemoveCompany action, where it is used as a safety check: a profile is only unlinked if it is currently linked to this exact company. Ignored for other actions.

Response

OK

signedLinkstring

Signed, time-limited download link to the result file. Only set for the Export action, and only when at least one profile was exported; null for every other action.

Changes

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