paymo.clients.add
Add a client to the authenticated user's company.
Authentication
This method requires authentication by a user with admin privileges.
Note: This method requires an HTTP POST request.
Arguments
api_key (Required)- Your application key. See here for more details.
auth_token (Required)- Authentication token received upon login.
name (Required)- Name of the new client.
address (Optional)- Address of the client.
city (Optional)- City.
state (Optional)- State.
postal_code (Optional)- Zip / Postal Code.
country (Optional)- Country.
phone (Optional)- Phone number.
fax (Optional)- Fax number.
email (Optional)- Email address.
website (Optional)- Website address.
contact_name (Optional)- Contact person's name.
contact_email (Optional)- Contact person's email address.
contact_mobile (Optional)- Contact person's mobile phone number.
contact_phone (Optional)- Contact person's phone number.
contact_fax (Optional)- Contact person's fax number.
Example Response
<?xml version="1.0" encoding="UTF-8"?>
<response status="ok">
<client id="140" />
</response>
Error Codes
101: Unknown API method- The requested method was not found.
102: Unknown response format- The requested response format was not found.
103: Invalid API Key- The API key passed was not valid.
104: Invalid auth token / Login failed- The login details or auth token passed were invalid.
105: Insufficient permissions- The user making the method call did not have the required permissions.
106: Service currently unavailable- The service is temporarily unavailable.
107: Too many requests for this API key- The application has reached the limit for number of API calls during a specific time period. Wait a bit and try again.
108: HTTP POST request expected- The method required that parameters are sent using an HTTP POST request.
208: Blank name- Name argument was blank.