API Reference

Bulk update external IDs

post
https://api.sisu.co/api/v3/external-id-migration

Bulk-modifies all externalservice* ID mappings for a team by prepending or appending a fixed string
to the stored external ID values. Scoped to a single external service. Guarded by a named team parameter
so the operation cannot be run more than once accidentally.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
enum
required

Whether to prepend or append the value. Use 'prepend' to add the value before each existing ID, 'append' to add it after.

Allowed:
string
required
length ≥ 1

The string to prepend or append to every matching external ID (e.g. 'fub_'). Must be non-empty.

targets
array of strings
required
length ≥ 1

One or more external ID types to update. Valid values: 'agent', 'transaction', 'contact', 'team', 'document', 'activity_instance', 'metric_instance', 'client_item'. Duplicates are ignored.

Targets*
string
required
length ≥ 1

The external service whose IDs should be modified (e.g. 'fub'). Only rows matching this service ID and the team are affected.

string
required
length ≥ 1

Name of a team-level Parameter to check before executing. If the parameter already exists the request is rejected with 409, preventing accidental re-runs. On success the parameter is saved as a boolean true.

Responses

Updated 4 months ago

Language
Credentials
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 4 months ago