Ultimate Member Zapier API Documentation

Overview

The Ultimate Member Zapier integration provides a comprehensive API for automating user management workflows between WordPress sites using Ultimate Member and external applications through Zapier. This documentation outlines all available endpoints, parameters, authentication methods, and data structures for Zapier app review compliance.

Plugin Version: 1.0.12
Required Ultimate Member Version: 2.9.2+
WordPress Version: 5.5+
PHP Version: 7.4+

Authentication

Method

HTTP Basic Authentication using WordPress Application Passwords

Headers

X-Request: um_zapier
Authorization: Basic [base64-encoded credentials]

Authentication Test Endpoint

URL: {site_url}/?action=um_zapier_auth_test
Method: POST
Purpose: Validates connection between Zapier and Ultimate Member

Response:

{
  "success": true,
  "data": "UM Zapier is connected!"
}

Core Endpoints

1. User Registration/Creation

Action: um_register_user
URL: {site_url}/?action=um_register_user
Method: POST

Required Parameters

Parameter Type Description
username string Username or email address
um_actions_triggers integer Zapier action trigger ID
um_account_role string User role to assign
um_account_status string Account status (approved, awaitingemailconfirmation, etc.)
um_update_on_exists string "Yes" or "No" - Update existing user if found

Optional Parameters

All Ultimate Member custom fields plus WordPress user fields: - first_name (string) - last_name (string) - user_email (string) - user_password (string) - display_name (string) - user_url (string) - Custom UM fields based on form configuration

Response Success (201)

{
  "success": true,
  "data": {
    "message": "User account has been created.",
    "user": { user_data },
    "requests": user_id
  }
}

Response Error (400)

{
  "success": false,
  "data": "Error message"
}

2. User Update

Action: um_update_user
URL: {site_url}/?action=um_update_user
Method: POST

Required Parameters

Parameter Type Description
username string Username or email to identify user
um_actions_triggers integer Zapier action trigger ID
um_account_role string User role to assign
um_account_status string Account status

Optional Parameters

Same as registration endpoint - all UM custom fields and WordPress user fields

Response Success (200)

{
  "success": true,
  "data": "User account has been updated."
}

3. User Deletion

Action: um_delete_user
URL: {site_url}/?action=um_delete_user
Method: POST

Required Parameters

Parameter Type Description
username string Username or email to identify user
um_actions_triggers integer Zapier action trigger ID
email_on_account_deletion string "Yes" or "No" - Send deletion email

Response Success (200)

{
  "success": true,
  "data": "The account has been successfully deleted."
}

4. Get Available Fields

Action: um_get_fields
URL: {site_url}/?action=um_get_fields
Method: POST

Required Parameters

Parameter Type Description
get_fields integer Field group ID

Response Success (200)

Returns array of field definitions: 
{
  "success": true,
  "data": [
    {
      "id": "field_key",
      "key": "field_key",
      "label": "Field Label",
      "type": "string|number|boolean",
      "required": true|false,
      "list": false,
      "search": false,
      "altersDynamicFields": false,
      "choices": { "key": "value" } // For select/radio fields
    }
  ]
}

5. Get Account Statuses

Action: um_get_account_statuses
URL: {site_url}/?action=um_get_account_statuses
Method: POST

Response Success (200)

{
  "success": true,
  "data": {
    "approved": "Approved",
    "awaiting_email_confirmation": "Awaiting Email Confirmation",
    "awaiting_admin_review": "Awaiting Admin Review",
    "inactive": "Inactive",
    "rejected": "Rejected"
  }
}

6. Get Account Roles

Action: um_account_roles
URL: {site_url}/?action=um_account_roles
Method: POST

Response Success (200)

{
  "success": true,
  "data": {
    "member": "Member",
    "contributor": "Contributor",
    "administrator": "Administrator"
  }
}

7. Get Zap Actions Options

Action: um_get_zap_actions_options
URL: {site_url}/?action=um_get_zap_actions_options
Method: POST

Response Success (200)

{
  "success": true,
  "data": {
    "id": "get_fields",
    "key": "get_fields",
    "label": "UM Field Group",
    "type": "string",
    "helpText": "Choose a UM Field group created in WP Admin > Ultimate Member > Zaps.",
    "choices": { "group_id": "group_name" },
    "altersDynamicFields": true,
    "required": true
  }
}

8. Get Zap Triggers Options

Action: um_get_zap_triggers_options
URL: {site_url}/?action=um_get_zap_triggers_options
Method: POST

Response Success (200)

{
  "success": true,
  "data": {
    "id": "get_fields",
    "key": "get_fields", 
    "label": "UM Field Group",
    "type": "string",
    "helpText": "Choose a UM Field group created in WP Admin > Ultimate Member > Zaps.",
    "choices": { "trigger_id": "trigger_name" },
    "altersDynamicFields": true,
    "required": true
  }
}

Webhook Triggers

Trigger Endpoints

Base URL: {site_url}/
Method: POST (Webhooks sent to Zapier)

Available Triggers

Trigger Description Data Sent
um_registration_complete When a new user registers User profile data
um_user_login When a user logs in User profile data
um_delete_user When a user deletes account User profile data
um_user_edit_profile When user updates profile Updated user data
um_admin_approve_account When admin approves pending account User profile data
um_user_email_activation When user activates via email User profile data
um_user_updated_account When user updates account form User profile data

Trigger Subscription

Action: umm_zapier_subscribe
URL: {site_url}/?action=umm_zapier_subscribe
Method: POST

Required Parameters

Parameter Type Description
group_field_id integer Trigger group ID
subscription_target_url string Zapier webhook URL

Trigger Testing

Action: um_zapier_activity_perform_list
URL: {site_url}/?action=um_zapier_activity_perform_list
Method: POST

Required Parameters

Parameter Type Description
group_field_id integer Trigger group ID
user_id integer User ID for testing (optional)

Response Success (200)

{
  "id": 123,
  "um_zap_name": "Trigger Name",
  "um_zap_id": 123,
  "user_id": 456,
  "user_email": "user@example.com",
  "first_name": "John",
  "last_name": "Doe"
  // ... additional custom fields
}

Field Types Support

Supported Field Types

  • text → string
  • textarea → text 
  • email → string
  • url → string
  • tel → string
  • number → number
  • select → string with choices
  • radio → string with choices
  • checkbox → boolean
  • multiselect → array
  • date → string (YYYY-MM-DD format)
  • time → string (HH:MM format)
  • country → string (country code converted to label)
  • image → string (URL)
  • file → string (URL)

Field Conversion Rules

  • Date fields: Converted to YYYY-MM-DD format
  • Time fields: Converted to HH:MM format 
  • Country fields: Country code converted to readable label
  • Image/File fields: Return full URL to media
  • Array fields: Automatically handled as comma-separated or JSON

Error Handling

Common Error Responses

Authentication Failed (401)

{
  "success": false,
  "data": "Zapier Authorization Failed"
}

Zap Disabled (400)

{
  "success": false,
  "data": "This UM Zap is not running or disabled."
}

User Not Found (400)

{
  "success": false,
  "data": "Account not found in the website"
}

User Already Exists (400)

{ "success":false, "data":"The Email address or Username is already registered. To update an existing user, turn \"On\" the option \"Update when the account exists\"." }

Rate Limiting

No explicit rate limiting is implemented. WordPress and server-level rate limiting may apply.

Data Privacy & Security

  • All communications use HTTPS
  • Authentication via WordPress Application Passwords
  • User data transmitted only for configured fields
  • Webhook URLs validated and stored securely
  • No sensitive data logged in plain text

API Versioning

The API follows the plugin version. Current version indicators: - Plugin header version: 1.0.12 - Required UM core: 2.9.2+ - API compatibility tracked via um_zapier_app_version option

Testing

Development Environment Setup

  1. Install Ultimate Member plugin
  2. Install UM Zapier extension
  3. Create Application Password for authentication
  4. Configure Zap triggers/actions in WP Admin
  5. Test endpoints using provided authentication

Test Data

Sample responses include placeholder data for testing: - Email fields: test@example.com - Text fields: sample value - Dates: Current timestamp in ISO format

Support

This documentation is for Ultimate Member Zapier Plugin v1.0.12. For the latest updates, refer to the official Ultimate Member documentation.