Release a client
End your relationship with one direct client, for good. One-way: unlike blocking, a release cannot be undone.
Reseller accounts only. Request access.
The client organization to release.
curl -X POST 'https://backend.omnidim.io/api/v1/reseller/clients/release' \ -H 'Authorization: Bearer YOUR_API_KEY' \ -H 'Content-Type: application/json' \ -d '{ "organization_id": 5678 }'
{ "success": true, "organization_id": 5678, "reverted_credits": { "deducted": 12.5, "refunded": 10 }, "user_ids": [ 1234 ], "detached_numbers": { "91": { "agent_id": 412, "sms_enabled": false } }, "transferred_numbers": [ 91 ] }
BearerAuthAuthorizationBearer <token>Bearer token authentication. Obtain your API key from the OmniDimension dashboard.
application/jsonorganization_id*integerThe client organization to release.
Response body
application/jsonThe client was released.
application/jsonsuccess?booleanorganization_id?integerreverted_credits?The balance returned to you, or {} when the client had
nothing to return.
user_ids?array<integer>The client users whose logins were retired.
detached_numbers?Numbers detached from their agents, keyed by number id.
transferred_numbers?array<integer>Numbers that transferred back to you.
Preview releasing a client
What releasing a client would do, changing nothing. Call it before POST /reseller/clients/release to confirm the amounts and the numbers that come back.
Update user expiry
Set or remove the expiry date on a child user. The user must belong to a child organization of your reseller.