🔎 Management API

Number of APIs: 161

Management API

The Management API allows you to programmatically do what the Campaign Manager does.
For example, use it for management purposes and backoffice systems.

For more background information about this API, see Management API overview

Ensure you authenticate to make requests to the API.

⚠️ Warnings:

• This API is not meant to be used in real-time integrations that directly serve your end users.
  • Integrate with Talon.One directly and send real-time data, see the Integration API reference docs.
  • Integrate with Talon.One from a CEP or CDP platform, see the Third-party API reference docs.
• This API supports a maximum of 3 requests per second for each of these endpoints.

Authentication

The API key authentication gives you access to the endpoints selected by the admin who created the key. Using an API key is the recommended authentication method.

The key must be generated by an admin and given to the developer that requires it:

1. Log into the Campaign Manager and click Account > Management API keys.
2. Click Create Key and give it a name.
3. Set an expiration date.
4. Choose the endpoints the key should give access to.
5. Click Create Key.
6. Share it with your developer.

The developer can now use the API key in the HTTP header, prefixing it with ManagementKey-v1:

Authorization: ManagementKey-v1 bd9479c59e16f9dbc644d33aa74d58270fe13bf3

Security Scheme Type: API KeyHeader parameter name: Authorization

1. Stores - Create store POST {{baseUrl}}/v1/applications/:applicationId/stores

2. Collections - List collections in Application GET {{baseUrl}}/v1/applications/:applicationId/collections?pageSize=1000&skip=10&sort=value&withTotalResultSize=true&name=value

3. Accounts and users - List users in account GET {{baseUrl}}/v1/users?pageSize=1000&skip=10&sort=value

4. Accounts and users - Get user GET {{baseUrl}}/v1/users/:userId

5. Accounts and users - Update user PUT {{baseUrl}}/v1/users/:userId

6. Accounts and users - Delete user DELETE {{baseUrl}}/v1/users/:userId

7. Accounts and users - Validate Okta API ownership GET {{baseUrl}}/v1/provisioning/okta

8. Accounts and users - Create SCIM user POST {{baseUrl}}/v1/provisioning/scim/Users

9. Accounts and users - Get SCIM user GET {{baseUrl}}/v1/provisioning/scim/Users/:userId

10. Accounts and users - Update SCIM user PUT {{baseUrl}}/v1/provisioning/scim/Users/:userId