Cargado API is in beta. The API may change in breaking ways.
curl --request POST \
--url https://api.cargado.com/users/updateByEmail \
--header 'Content-Type: application/json' \
--header 'api-key: <api-key>' \
--data '
{
"users": [
{
"email": "<string>",
"externalId": "<string>"
}
]
}
'{
"results": [
{
"status": "MATCHED",
"email": "<string>",
"id": "<string>",
"externalId": "<string>"
}
]
}Update user external IDs by email. Matches users in your organization by email and assigns each an externalId for use in subsequent API calls (e.g., load sync coverage assignment).
curl --request POST \
--url https://api.cargado.com/users/updateByEmail \
--header 'Content-Type: application/json' \
--header 'api-key: <api-key>' \
--data '
{
"users": [
{
"email": "<string>",
"externalId": "<string>"
}
]
}
'{
"results": [
{
"status": "MATCHED",
"email": "<string>",
"id": "<string>",
"externalId": "<string>"
}
]
}Documentation Index
Fetch the complete documentation index at: https://docs.cargado.com/llms.txt
Use this file to discover all available pages before exploring further.