Activate a Location
The steps to activate a location depend on whether you are a trusted or non-trusted partner, but the outcome of activating is always the same. Activating a location:
- Queues up Starter Export files to be generated within 24 hours.
- Enables the location to generate deltas
- Creates an API user, if necessary
Trusted Partners: Activating a Location
This endpoint is available to Meevo Trusted Partners only.
To activate a location, send a POST request to the entitlements endpoint, making sure to include the tenant ID and location ID in the route, as well as the bearer JSON Web Token in the header. Once the exports have been generated for an activated location, you can, if necessary, make this same call again to queue up Starter Exports for that location.
Note for multi-locations: You are billed according to your number of active locations. To avoid being billed for churn (locations who you are no longer doing business with), it is important that you deactivate defunct locations as described here.
Endpoint
POST {{MarketplaceURL}}/apps/partner/entitlements/{{tenantId}}/{{locationId}}
Example call
This example uses the Test Bed Marketplace URL (https://d18devmarketplace.meevodev.com). When your app or solution goes live, you will use the Production Marketplace URL.
POST https://d18devmarketplace.meevodev.com/apps/partner/entitlements/1/3
Example response
This message indicates the activation was successful.
{
"isSuccess": true,
"message": "Entitlement Activated"
}
Example response when Starter Exports are already queued for that location
If Starter Exports are already queued up for a location, in the response you will see:
"isSuccess": false,
The "message" will contain the phrases
- Unable to start CDC Full process.
- Cannot insert duplicate key row in object 'migr.MigrationQueue'
Non-Trusted Partners: Activating a Location
Non-trusted partners can activate new locations by emailing us at meevoapi@millenniumsi.com.
Note for multi-locations: You are billed according to your number of active locations. To avoid being billed for churn (locations who you are no longer doing business with), it is important that you deactivate defunct locations as described here.