• Documentation >
• Apps >
• Marketing >
• Robly

Robly

With Robly modules in Ibexa Connect, you can:

• create, update, retrieve, search, delete and unsubscribe contacts

• create, update, and search lists, and add and remove a contact from the list.

To get started with Robly, create an account at robly.com

Connect Robly to Ibexa Connect

To connect Robly app, you need to obtain the API ID and API Key values from your Robly account and insert them in the Robly module scenario.

1. Log in to your Robly account.

2. Click Settings > API Details. Copy the API ID and API Key to a safe.

   

3. Log in to your Ibexa Connect account, insert a Robly module scenario and click the Add button next to the Connection field.

   

4. In the Connection name field, enter a name for the connection.

5. In the API ID and API Key fields, enter the details copied in step 2 and click Save.

You have successfully established the connection. You can now begin editing your scenario and adding more Robly modules. If your connection needs reauthorization at any point, follow the connection renewal steps here.

Contacts

You can create, update, list, search, unsubscribe, and delete contacts using the following modules.

Search Contacts

Searches for existing contacts or lists them all.

Limit	Set the maximum number of contacts Ibexa Connect will return during one execution cycle. The default value is 10.

See Robly Contacts API reference for entering the field values to search the contacts that match the specified value.

Get a Contact

Retrieves an existing contact.

Contact	Select or map an option to select a contact whose details you want to retrieve.

For field descriptions, see the Robly Contacts API reference.

Create a Contact

Creates a new contact.

For field descriptions, see the Robly Contacts API reference.

Update a Contact

Updates an existing contact.

Contact	Select or map an option to select a contact whose details you want to update.

For field descriptions, see the Robly Contacts API reference.

Unsubscribe a Contact

Unsubscribes an existing contact.

Contact	Select the contact by: Select by Email Select by Member ID
Email	Select or map an Email you want to unsubscribe.
Member ID	Select or map a Member ID you want to unsubscribe.

Delete a Contact

Deletes an existing contact.

Contact	Select the contact by: Select by Email Select by Member ID
Email	Select or map an Email you want to delete.
Member ID	Select or map a Member ID you want to delete.

Lists

You can create, update, search, add and remove the contacts from the list using the following modules.

Search Lists

Searches for existing lists or lists them all.

Include All	Select whether to include all lists regardless of whether they show up on the signup form.
Limit	Set the maximum number of Lists Ibexa Connect will return during one execution cycle. The default value is 10.

Create a List

Creates a new list.

List Name	Enter a name to create a new mailing list.
Show on Sign Up Form	Select whether to display this list on the signup form.

Update a List

Updates an existing list.

List ID	Select or map the List ID whose details you want to update.
Name	Enter a new name for the mail list.

Add a Contact to the List

Adds an existing contact to the list.

Contact	Select or map an option to select a contact you want to add.

For field descriptions, see the Robly List API reference.

Remove a Contact from the List

Removes an existing contact from the list.

Contact	Select or map an option to select a contact you want to remove.

For field descriptions, see the Robly List API reference.

Other

You can call APIs using the following module.

Make an API Call

Performs an arbitrary authorized API call.

Note

For the list of available endpoints, refer to the Robly API documentation.

URL	Enter a path relative to http://api.robly.com/api. For example /v1/campaign/list.
Method	GET to retrieve information for an entry. POST to create a new entry. PUT to update/replace an existing entry. PATCH to make a partial entry update. DELETE to delete an entry.
Headers	Enter the desired request headers. You don't have to add authorization headers; we already did that for you.
Query String	Enter the request query string.
Body	Enter the body content for your API call.

Example of use - List Contacts

The following API call returns all contacts from your account.

URL: /v1/contacts

Method: GET

Matches of the search can be found in the module's Output under Bundle > Body. Our example returned 5 contacts.