Happy Business Starts Here

Zuora Staff

Subscriber Self-Care Portal Add users via API

Hi All,

 

In Subscriber portal, is there a way to add users via API?

 

I want to auto-add users when a new account created in Zuora

 

 

Thanks!

4 REPLIES 4
Highlighted
Zuora Product Team

Re: Subscriber Self-Care Portal Add users via API

We are in the process of getting this updated on the KC, but let me know if you have any follow up questions.

The API to send an invitation accepts one parameter of the work email address.  As a reminder the Contact must exist in Zuora before sending the invitation.  Also, this Contact can be any Contact on the Account (not only the Bill To/Sold To) as long as the work email address is populated.  You can initiate the call via callout or via API.

 

To use a callout, the callout must contain a Contact's work email. 

    The Base URL is set to <portal-base>/api/v1/users
    Parameters: email = BillToContact.WorkEmail
    HTTP Method: POST
    Body Format: application/json
    Username: Portal instance task ID
    Password: Portal instance token ID

 

To call via API:

   Pass in the same parameters to the API as mentioned in the callout

Type

Params

Values

HEAD

HEAD

POST

username

password

email

string

string

string

 

Zuora Staff

Re: Subscriber Self-Care Portal Add users via API

What about removing users - e.g. if a contact no longer works at the company?  Is this supported via API?

Zuora Product Team

Re: Subscriber Self-Care Portal Add users via API

To delete a user via email, follow the below:

The Base URL is set to <portal-base>/api/v1/users/destroy_by_uid
    Parameters:
            uid - BillToContact.WorkEmail
    HTTP Method: DELETE
    Body Format: application/json
    Username: Portal instance task ID
    Password: Portal instance token ID
 
To call via API:
   Pass in the same parameters to the API as mentioned in the callout
Type
Params
Values
HEAD
HEAD
DELETE
username
password
uid
string
string
string
 
Zuora Staff

Re: Subscriber Self-Care Portal Add users via API

Where do we get the
    Username: Portal instance task ID
    Password: Portal instance token ID

 

to use the APIs?
I've tried using the Connect login/pwd used to connect the Portal to my tenant, but I keep getting an  HTTP 401 'HTTP Basic: Access denied.'

I don't see anything else in the tenant's configurations resembling a taskID/tokenID.

Thanks,

 

Serg