Creates a new empty (unconfigured) Nimbus user, based on the Organization Unit and O365 ID provided from existing users on your tenant.

☝Note: Only one user can be added per transaction.

{
 "o365Id": "<guid>",
 "organizationUnitId": "<guid>"
}

• 200 - Successful response.

Requests the current configuration of an existing/template user. 

☝Note: Only one user can be requested per transaction.

Empty Body

• 200 - Successful response

Lists every User configured within an Organization Unit, optionally including its subtree, together with each user's full configuration — the same detail level as → GET Details of Existing User, returned for many users at once.

☝Note: Choose the response format via the format query parameter: json returns an array of user objects; csv returns a file that is column-for-column identical to the Export Configuration file produced from the User Administration UI.

• organizationUnitId: the Organization Unit to list Users from.
• includeDescendants (optional, default false): when true, also returns Users from every OU below the given one.
• skip / take (optional): paging offset and page size.
• format (optional, default json): json or csv.

✅ Preconditions: Uses the existing Provisioning.User.Read role permission — no additional role needs to be granted.

• Results are always scoped to the Organization Units your API app was granted (→ Chapter: Step 2 above). If includeDescendants is set, the returned subtree is always intersected with that granted scope — a request against an ungranted parent, sibling, or the tenant root never returns anything outside what the app was actually granted.

Empty Body

JSON (format=json): an array of user configuration objects (same shape as → GET Details of Existing User) for every User in scope.

CSV (format=csv): the same file, column-for-column, as the Export Configuration file from the User Administration UI — so existing import/export tooling built around that file works unchanged against the API response.

💡 Every response also carries these headers, reporting how many Users were requested vs. actually returned:

• X-Export-Total-Requested
• X-Export-Total-Succeeded
• X-Export-Total-Failed

• 200 - Successful response
• 400 - Invalid query parameters (e.g. unknown format value)
• 403 - Organization Unit not allowed

Performs a check in available Nimbus licenses, as also reflected in the Admin UI: License Management.

Returns details for all licenses:

• License Name/Type. Refer to Nimbus Features for more details.
• Total number of licenses purchased.
• Total number of licenses in use.
• Total number of licenses available.

Empty Body

• 200 - Successful response

Creates a copy of an existing user, using their Nimbus User settings as template.

☝Note: Only one user can be copied per transaction.

 ✅ Preconditions: You require both the O365 ID of EXISTING (Template User) the NEW (copy target) user for the request body.

• Template User - Skill-based (manual) User Assignment Type requirement: The templated user must exist standalone in Nimbus and be Contact Center licensed for the necessary features to be copied. MS-Teams synched users will be rejected by the API command.
• New User (copy target): The new User's O365 ID will be needed for this command, as retrieved from your Azure / Entra ID directory.

{
 "newO365Id": "<guid>",
 "sourceO365Id": "<guid>"
}

• 200 - Successful response.
• 400 - “SourceO365Id” or “NewO365Id” are required. Also relates to user duplication error.
• 401 - Missing ID (Tenant, App, etc.) with specific details provided. Also shows for permissions or access related errors.
• 403 - Organization Unit not allowed. Also shown when no Licenses are available (License Management).
• 404 - A source user with this "SourceO365Id" was not found.
• 409 - User already exists.
• 500 - Unable to check configuration

Removes a User profile from the Nimbus. The User is also removed as Service Agent/Service Owner from the services where applicable.

✅ Preconditions: 

• You require the O365 ID of an existing Nimbus User. Specifying a O365 ID that is not part of the Nimbus user pool will return an error. 
• Only manually added “Skill-Based” users are allowed to be deleted. MS-Teams synched users will be rejected by the API command.

Results: 

• General User Settings - Licenses assigned to the user become available again.
• Nimbus Reporting¹: The user is still searchable by name in historical reporting and related Nimbus UIs such as Customer Insights.
• Change History: 
  • Will record the User deletion was done via API
  • Specify the user who carried out the API call

¹💡Good to know: If the user is re-added (using the exact same O365 ID) it will get all the same reporting data from before. However, any configuration data is lost and needs to be restored manually or via → COPY Existing user command.

{
 "o365Id": "<guid>",
}

• 200 - Successful response

Requests the current configuration of an existing/template service (to copy). 

☝Note: Only one service can be requested per transaction.

Empty Body

• 200 OK
• 404 Not found

Lists every Service configured within an Organization Unit, optionally including its subtree, together with each service's full configuration — the same detail level as → GET Details of existing Service, returned for many services at once.

☝Note: Choose the response format via the format query parameter: json returns an array of service objects; csv returns a file that is column-for-column identical to the Export Configuration file produced from the Nimbus Admin UI.

• organizationUnitId: the Organization Unit to list Services from.
• includeDescendants (optional, default false): when true, also returns Services from every OU below the given one.
• skip / take (optional): paging offset and page size.
• format (optional, default json): json or csv.

✅ Preconditions: Uses the existing Provisioning.Service.Read role permission — no additional role needs to be granted.

• Results are always scoped to the Organization Units your API app was granted. If includeDescendants is set, the returned subtree is always intersected with that granted scope — a request against an ungranted parent, sibling, or the tenant root never returns anything outside what the app was actually granted.
• Same Service-related eligibility rules already apply here as for the other Service endpoints on this page (skill-based Services with a Nimbus provisioning footprint).
• [DELTA: confirm with product whether this listing endpoint sits behind its own toggle in Provisioning Tenant Settings, or is enabled tenant-wide once the app has the OrganizationUnit-scoped permission — feature flag name is APIExportUserServices.]

Empty Body

JSON (format=json): an array of service configuration objects (same shape as → GET Details of existing Service) for every Service in scope.

CSV (format=csv): the same file, column-for-column, as the Export Configuration file from the Nimbus Admin UI — so existing import/export tooling built around that file works unchanged against the API response.

💡 Every response also carries these headers, reporting how many Services were requested vs. actually returned:

• X-Export-Total-Requested
• X-Export-Total-Succeeded
• X-Export-Total-Failed

• 200 - Successful response
• 400 - Invalid query parameters (e.g. unknown format value)
• 403 - Organization Unit not allowed

Creates a new service with user assignment type “None”.

☝Note: Only one service can be added per transaction.

 {
 "name": "Name",
 "serviceDisplayName": "Display Name",
 "upn": "service@upn.com",
 "organizationUnitId": "id",
 optional
 "pstnNumber": 123123123,
 }

• 200 OK
• 400 Bad Request
• 403 License not available

You must have sufficient licenses available before you can provision a service. If there are no licenses available, the provisioning of the new service will fail.

💡Note the service fields character length limitations below.

 {
 "name": "Name",
 "serviceDisplayName": "Display Name",
 "upn": "service@upn.com",
 "sourceServiceId": "source-service-id",
 optional
 "pstnNumber": 123123123,
 "mailboxUpn": "servicemail@mail.com"
 }

• 200 OK - Provisioning successful.
• 400 Bad Request - Provisioning failed (e.g. no licenses available, invalid service ID).

Removes a service from Nimbus.

Results: 

• General Service Settings - Licenses assigned to the service become available again.
• Nimbus Reporting¹: The service is still searchable by name in historical reporting and related Nimbus UIs such as Customer Insights.
• Service Permissions - Users assigned as Service Owners / Service Agents are removed.
• Change History: 
  • Will record the service deletion was done via API
  • Specify the user who carried out the API call

{
 "serviceId": "service-id",
}

• 200 Successful response
• 400 Bad Request
• 403 Forbidden
• 409 Conflict

Empty Body

An array of Organization Unit entries, each with id, name, and parentOrganizationUnitId.

[
  {
    "id": "<guid>",
    "name": "Sales",
    "parentOrganizationUnitId": "<guid>"
  }
]

[DELTA: confirm exact response shape/field names with engineering before publishing.]

• 200 - Successful response
• 401 - Missing or invalid app authentication

Lists all Workflows and Workflow Templates the caller is allowed to export, together with their Organization Unit IDs. Use this first to resolve what to export before calling → POST Export Workflows & Templates.

Only entities within the OUs your API app was granted are returned.

Empty Body

Two lists — workflows and workflowTemplates — each entry carrying id, name, workflowType, and organizationUnitId.

{
 "workflows": [
   {
     "id": "<guid>",
     "name": "Main IVR",
     "workflowType": "Unify",
     "organizationUnitId": "<guid>"
   }
 ],
 "workflowTemplates": [
   {
     "id": "<guid>",
     "name": "Standard Template",
     "workflowType": "Audio",
     "organizationUnitId": "<guid>"
   }
 ]
}

• 200 - Successful response

Exports Workflows and/or Workflow Templates as JSON envelopes — identical in format to the UI export (file format version 1.1). You control the selection through the request body:

• Specific entities — pass the workflowIds and/or workflowTemplateIds you want (e.g. from a prior Discover call).
• Everything in scope — leave both id lists empty to export all Workflows and Templates within the OUs your app is authorized for. To limit this to a single OU, grant the app only that OU; to cover the whole tenant, grant it all OUs.

☝Note: Where the export is stored and whether existing files are overwritten is handled entirely by your consuming script — the API only returns the content.

{
 "workflowIds": ["<guid>"],
 "workflowTemplateIds": [],
 "stripTemplateLink": true
}

stripTemplateLink (default true) removes the link to a Workflow Template so the Workflow exports on its own.

The exported envelopes plus a summary (requested, succeeded, failed, and a failures list). The same totals are also returned as response headers:

• X-Export-Total-Requested
• X-Export-Total-Succeeded
• X-Export-Total-Failed

💡 A single failing entity does not abort the run — it is counted in failed and listed under failures. IDs outside your authorized OUs are reported as NotFoundOrOutOfScope.

{
 "envelopes": [
   {
     "workflowFormatVersion": "1.1",
     "sourceProduct": "Nimbus",
     "sourceTenantId": "<guid>",
     "sourceOrganizationUnitId": "<guid>",
     "kind": "Workflow",
     "workflowType": "Unify",
     "workflow": { }
   }
 ],
 "requested": 1,
 "succeeded": 1,
 "failed": 0,
 "failures": []
}

• 200 - Successful response (an empty selection returns an empty result with zero totals).

  {
    "id": "guid",
    "name": "string",
    "description": "string",
    "organizationUnitId": "guid",
    "workflows": []
  }

• 200 - Successful response

{
  "id": "guid",
  "name": "string",
  "description": "string",
  "organizationUnitId": "guid",
  "botConfigurationId": "guid",
  "profile": 0,
  "generalInstructions": "string",
  "outcomesAndToolsInstructions": "string",
  "initialMessage": "string",
  "finalMessage": "string",
  "tone": "string",
  "language": string,
  "userVoice": string*,
  "maxSessionDurationSeconds": 180**,
  "inactivityTimeoutSeconds": 45**,
  "modalities": [0],
  "hasVirtualUserLicense": "boolean"
}

*Available user voices: Alloy, Ash, Ballad, Cedar, Coral, Echo, Marin, Sage, Shimmer, Verse

**Default values, can be changed.

• 200 - Successful response
• 404 - Not found

{
  "name": "string",
  "generalInstructions": "string",
  "initialMessage": "string",
  "finalMessage": "string",
  "maxSessionDurationSeconds": 600*,
  "inactivityTimeoutSeconds": 60*
}

*Default values, can be changed.

• 200 - Successful response, returns the updated Virtual User
• 404 - Not found

{
"sourceVirtualUserId": "<guid>",
"newName": "Support VU (pre-change)"
}

• 200 - Successful response, returns the new Virtual User
• 404 - Source Virtual User not found

Schedules one outbound callback on the Service with the given serviceId. Only one call can be scheduled per request. Requires the role Provisioning.OutboundCall.Create.

☝️ A second pending call with the same referenceId on the same Service is rejected; the response contains the ID of the existing call.

Request fields:

{
 "destination": "+41441234567",
 "scheduledAt": "2026-10-01T14:30:00+02:00",
 "referenceId": "CRM-4711",
 "maxAttempts": 3
}

The scheduled call, with the status Scheduled. Keep the id to query or cancel the call later.

{
 "id": "<guid>",
 "serviceId": "<guid>",
 "referenceId": "CRM-4711",
 "scheduledAt": "2026-10-01T12:30:00+00:00",
 "status": "Scheduled",
 "attemptsMade": 0
}

• 201 - Call scheduled
• 400 - Invalid request: destination is not E.164, scheduledAt has no UTC offset, is more than 5 minutes in the past or more than 6 months ahead, or an optional field is outside its allowed range (values are rejected, not adjusted)
• 401 - Token invalid or expired, required role missing, or the app is not permitted in the Provisioning API configuration.
• 403 - Feature not enabled for the tenant, or Service outside the OUs granted to the app
• 404 - Service not found
• 409 - A pending call with the same referenceId already exists on this Service (the response contains existingOutboundCallId)
• 422 - The Service has no outbound calls enabled, is not open at the scheduled time, or the request was rejected by the outbound task engine (e.g. the tenant limit of scheduled outbound tasks per Service is reached)

Empty Body

The call with its status. reason is only present for NotExecuted, completedAt once the call has finished.

{
 "id": "<guid>",
 "serviceId": "<guid>",
 "referenceId": "CRM-4711",
 "scheduledAt": "2026-10-01T12:30:00+00:00",
 "status": "NotExecuted",
 "reason": "OutsideOpeningHours",
 "attemptsMade": 0,
 "completedAt": "2026-10-01T12:30:02+00:00"
}

Possible statuses:

• 200 - Successful response
• 403 - Required role missing, feature not enabled for the tenant, or Service outside the OUs granted to the app
• 404 - Service or outbound call not found

Empty Body

• 204 - Call cancelled
• 403 - Required role missing, feature not enabled for the tenant, or Service outside the OUs granted to the app
• 404 - Service or outbound call not found
• 409 - The call is in progress or already finished and can no longer be cancelled