Summary
The Change Subscription Owner request allows you to change the owner of a subscription to an existing user via the API.
NOTE: The owner of a subscription must be an existing user of the subscription, and must have Admin permissions.
If the subscription has no other users, you must add a user. If an existing user does not have Admin permissions, you must update the user subscription role. These can also be achieved using the API.
Process
Changing the owner of a subscription
To assign a new owner to a subscription:
- Construct an API call using the following information:
Method POST URL https://cloudapi.exclaimer.com Endpoint EITHER exclaimerapi OR any custom endpoint you may have been provided Version 1.0 Resource subscriptions - Construct your request by adding your subscription ID. For help locating your subscription ID, see How to locate your subscription ID in the Exclaimer portal.
- Enter change-owner.
- Construct the body of the request using the following information:
EmailAddress User email address. UserID User reference ID.
NOTE: The user reference ID is the value specified when adding a user. To check user details for a subscription, make a GetUser request.
Adding a new user to the subscription
To add a new user:
- Construct an API call using the following information:
Method POST URL https://cloudapi.exclaimer.com Endpoint EITHER exclaimerapi OR any custom endpoint you may have been provided Version 1.0 Resource subscriptions - Construct your request by adding your subscription ID. For help locating your subscription ID, see How to locate your subscription ID in the Exclaimer portal.
- Enter users.
- Construct the body of the request using the following information:
EmailAddress User email address. Roles EITHER:
admin - gives the user full admin permissions. This option must be used to transfer ownership to this user.
OR
editor - gives the user edit permissions over allocated folders.
SendWelcomeEmailToCustomer true/false UserID User reference ID.
Granting a user Admin permissions
To update a user's role:
- Construct an API call using the following information:
Method PUT URL https://cloudapi.exclaimer.com Endpoint EITHER exclaimerapi OR any custom endpoint you may have been provided Version 1.0 Resource subscriptions - Construct your request by adding your subscription ID. For help locating your subscription ID, see How to locate your subscription ID in the Exclaimer portal.
- Enter users followed by the User ID.
- As the body of the request, enter roles followed by admin to grant the user admin permissions.
Note: Enter editor to remove admin permissions and grant the user normal edit permissions.
Deleting the original owner of a subscription after changing owners
To delete a user:
- Construct an API call using the following information:
Method DELETE URL https://cloudapi.exclaimer.com Endpoint EITHER exclaimerapi OR any custom endpoint you may have been provided Version 1.0 Resource subscriptions - Construct your request by adding your subscription ID. For help locating your subscription ID, see How to locate your subscription ID in the Exclaimer portal.
- Enter users followed by the User ID. For help locating a User ID, see the Get Subscription Users data.
Responses
The SUCCESS response is:
- 204 No Content
The FAILURE responses are:
- 400 Bad Request / Missing Field
- 401 Unauthorized
- 404 Not Found
- For UpdateSubscriptionUserRoles and DeleteUser, 403 Forbidden
- 415 Unsupported Media Type
- 500 Internal Server Error
NOTE: For JSON and cURL examples, see the Add Subscription User, Update Subscription User Roles, Change Subscription Owner, and Delete Subscription User data.