Skip to main content
Server path: /repairshopr-customers | Type: Application | PCID required: Yes

Tools

ToolDescription
repairshopr_customers_create_contactsCreates a Contact
repairshopr_customers_create_customersCreates a Customer
repairshopr_customers_create_leadsCreates a Lead
repairshopr_customers_create_portal_usersCreates a Portal User
repairshopr_customers_create_portal_users_create_invitationCreates an Invitation for a Portal User
repairshopr_customers_delete_by_idDeletes a Customer by ID
repairshopr_customers_delete_contacts_by_idDeletes a Contact
repairshopr_customers_delete_portal_users_by_idDeletes a Portal User by ID
repairshopr_customers_get_by_idRetrieves a Customer by ID
repairshopr_customers_get_contacts_by_idRetrieves a Contact by ID
repairshopr_customers_get_leads_by_idRetrieves a Lead by ID
repairshopr_customers_list_contactsReturns a paginated list of Contacts
repairshopr_customers_list_customersReturns a paginated list of customers
repairshopr_customers_list_customers_autocompleteReturns a paginated list of customers for autocomplete query
repairshopr_customers_list_customers_latestReturns latest Customer
repairshopr_customers_list_leadsReturns a paginated list of Leads
repairshopr_customers_list_portal_usersReturns a paginated list of Portal Users
repairshopr_customers_list_searchSearch all the things
repairshopr_customers_update_contacts_by_idUpdates an existing Contact
repairshopr_customers_update_customers_by_idUpdates an existing Customer by ID
repairshopr_customers_update_leads_by_idUpdates an existing Lead by ID
repairshopr_customers_update_portal_users_by_idUpdates an existing Portal User by ID

repairshopr_customers_create_contacts

Creates a Contact Parameters:
ParameterTypeRequiredDefaultDescription
address1stringNoThe address1 value
address2stringNoThe address2 value
citystringNoThe city value
customer_idintegerYesCustomer Id
emailstringNoThe email value
mobilestringNoThe mobile value
namestringNoThe name value
notesstringNoThe notes value
phonestringNoThe phone value
statestringNoThe state value
zipstringNoThe zip value

repairshopr_customers_create_customers

Creates a Customer Parameters:
ParameterTypeRequiredDefaultDescription
addressstringNoThe address value
address_2stringNoAddress 2
business_namestringNoBusiness Name
citystringNoThe city value
consentobjectNoThe consent value
emailstringNoThe email value
firstnamestringNoThe firstname value
get_billingbooleanNoGet Billing
get_marketingbooleanNoGet Marketing
get_reportsbooleanNoGet Reports
get_smsbooleanNoGet Sms
invoice_cc_emailsstringNoInvoice Cc Emails
invoice_term_idintegerNoInvoice Term Id
lastnamestringNoThe lastname value
mobilestringNoThe mobile value
no_emailbooleanNoNo Email
notesstringNoThe notes value
notification_emailstringNoNotification Email
opt_outbooleanNoOpt Out
phonestringNoThe phone value
propertiesobjectNoThe properties value
ref_customer_idintegerNoRef Customer Id
referred_bystringNoReferred By
statestringNoThe state value
tax_rate_idintegerNoTax Rate Id
zipstringNoThe zip value

repairshopr_customers_create_leads

Creates a Lead Parameters:
ParameterTypeRequiredDefaultDescription
addressstringNoThe address value
appointment_timestringNoAppointment Time
appointment_type_idintegerNoAppointment Type Id
business_namestringNoBusiness Name
citystringNoThe city value
contact_idintegerNoContact Id
convertedbooleanNoThe converted value
customer_idintegerNoCustomer Id
customer_purchase_idintegerNoCustomer Purchase Id
disabledbooleanNoThe disabled value
emailstringNoThe email value
first_namestringNoFirst Name
from_check_inbooleanNoFrom Check In
hidden_notesstringNoHidden Notes
last_namestringNoLast Name
likelihoodintegerNoThe likelihood value
location_idintegerNoLocation Id
mailbox_idintegerNoMailbox Id
message_readbooleanNoMessage Read
mobilestringNoThe mobile value
opportunity_amount_dollarsnumberNoOpportunity Amount Dollars
opportunity_start_datestringNoOpportunity Start Date
phonestringNoThe phone value
propertiesobjectNoThe properties value
signature_datastringNoSignature Data
signature_datestringNoSignature Date
signature_namestringNoSignature Name
statestringNoThe state value
statusstringNoThe status value
ticket_descriptionstringNoTicket Description
ticket_idintegerNoTicket Id
ticket_problem_typestringNoTicket Problem Type
ticket_propertiesobjectNoTicket Properties
ticket_subjectstringNoTicket Subject
ticket_type_idintegerNoTicket Type Id
user_idintegerNoUser Id
zipstringNoThe zip value

repairshopr_customers_create_portal_users

Creates a Portal User Parameters:
ParameterTypeRequiredDefaultDescription
contact_idintegerNoContact Id
customer_idintegerNoCustomer Id
emailstringNoThe email value
passwordstringNoThe password value
password_confirmationstringNoPassword Confirmation
portal_group_idintegerNoPortal Group Id

repairshopr_customers_create_portal_users_create_invitation

Creates an Invitation for a Portal User Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesThe id value

repairshopr_customers_delete_by_id

Deletes a Customer by ID Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesThe id value

repairshopr_customers_delete_contacts_by_id

Deletes a Contact Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesThe id value

repairshopr_customers_delete_portal_users_by_id

Deletes a Portal User by ID Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesThe id value

repairshopr_customers_get_by_id

Retrieves a Customer by ID Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesThe id value

repairshopr_customers_get_contacts_by_id

Retrieves a Contact by ID Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesThe id value

repairshopr_customers_get_leads_by_id

Retrieves a Lead by ID Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesThe id value

repairshopr_customers_list_contacts

Returns a paginated list of Contacts Parameters:
ParameterTypeRequiredDefaultDescription
customer_idintegerNoAny contacts attached to a Customer ID
pageintegerNoReturns provided page of results, each ‘page’ contains 25 results

repairshopr_customers_list_customers

Returns a paginated list of customers Parameters:
ParameterTypeRequiredDefaultDescription
sortstringNoA customer field to order by. Examples “firstname ASC”, “city DESC”.
querystringNoSearch query
firstnamestringNoAny customers with a first name like the parameter
lastnamestringNoAny customers with a last name like the parameter
business_namestringNoAny customers with a business name like the parameter
idinteger[]NoAny customers with ID included in the list
not_idinteger[]NoAny customers with ID not included in the list
emailstringNoThe email value
include_disabledstringNoWhether or not the returned list of customers includes disabled customers
pageintegerNoReturns provided page of results, each ‘page’ contains 25 results

repairshopr_customers_list_customers_autocomplete

Returns a paginated list of customers for autocomplete query Parameters:
ParameterTypeRequiredDefaultDescription
querystringNoSearch query

repairshopr_customers_list_customers_latest

Returns latest Customer

repairshopr_customers_list_leads

Returns a paginated list of Leads Parameters:
ParameterTypeRequiredDefaultDescription
statusesstring[]NoArray of statuses. Possible values are “New”, “Lead”, “First Contact”, “Opportunity”, “Prospect”, “Waiting on Client”, “In Negotiation”, “Pending”, “Won”, “Lost”.
status_liststringNoComma separated list of statuses.
usersinteger[]NoArray of user IDs.
mailbox_idsinteger[]NoArray of Mailbox IDs
has_ticketbooleanNoHas Ticket
querystringNoSearch query
pageintegerNoReturns provided page of results, each ‘page’ contains 25 results

repairshopr_customers_list_portal_users

Returns a paginated list of Portal Users Parameters:
ParameterTypeRequiredDefaultDescription
customer_idintegerNoReturns Portal Users that belong to a Customer ID
emailstringNoPortal User email
pageintegerNoReturns provided page of results, each ‘page’ contains 100 results

Search all the things Parameters:
ParameterTypeRequiredDefaultDescription
querystringNoSearch query

repairshopr_customers_update_contacts_by_id

Updates an existing Contact Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesThe id value
address1stringNoThe address1 value
address2stringNoThe address2 value
citystringNoThe city value
customer_idintegerNoCustomer Id
emailstringNoThe email value
mobilestringNoThe mobile value
namestringYesThe name value
notesstringNoThe notes value
phonestringNoThe phone value
statestringNoThe state value
titlestringNoThe title value
zipstringNoThe zip value

repairshopr_customers_update_customers_by_id

Updates an existing Customer by ID Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesThe id value
addressstringNoThe address value
address_2stringNoAddress 2
business_namestringNoBusiness Name
citystringNoThe city value
consentobjectNoThe consent value
emailstringNoThe email value
firstnamestringNoThe firstname value
get_billingbooleanNoGet Billing
get_marketingbooleanNoGet Marketing
get_reportsbooleanNoGet Reports
get_smsbooleanNoGet Sms
invoice_cc_emailsstringNoInvoice Cc Emails
invoice_term_idintegerNoInvoice Term Id
lastnamestringNoThe lastname value
mobilestringNoThe mobile value
no_emailbooleanNoNo Email
notesstringNoThe notes value
notification_emailstringNoNotification Email
opt_outbooleanNoOpt Out
phonestringNoThe phone value
propertiesobjectNoThe properties value
ref_customer_idintegerNoRef Customer Id
referred_bystringNoReferred By
statestringNoThe state value
tax_rate_idintegerNoTax Rate Id
zipstringNoThe zip value

repairshopr_customers_update_leads_by_id

Updates an existing Lead by ID Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesThe id value
addressstringNoThe address value
appointment_timestringNoAppointment Time
appointment_type_idintegerNoAppointment Type Id
business_namestringNoBusiness Name
citystringNoThe city value
contact_idintegerNoContact Id
convertedbooleanNoThe converted value
customer_idintegerNoCustomer Id
customer_purchase_idintegerNoCustomer Purchase Id
disabledbooleanNoThe disabled value
emailstringNoThe email value
first_namestringNoFirst Name
from_check_inbooleanNoFrom Check In
hidden_notesstringNoHidden Notes
last_namestringNoLast Name
likelihoodintegerNoThe likelihood value
location_idintegerNoLocation Id
mailbox_idintegerNoMailbox Id
message_readbooleanNoMessage Read
mobilestringNoThe mobile value
opportunity_amount_dollarsnumberNoOpportunity Amount Dollars
opportunity_start_datestringNoOpportunity Start Date
phonestringNoThe phone value
propertiesobjectNoThe properties value
signature_datastringNoSignature Data
signature_datestringNoSignature Date
signature_namestringNoSignature Name
statestringNoThe state value
statusstringNoThe status value
ticket_descriptionstringNoTicket Description
ticket_idintegerNoTicket Id
ticket_problem_typestringNoTicket Problem Type
ticket_propertiesobjectNoTicket Properties
ticket_subjectstringNoTicket Subject
ticket_type_idintegerNoTicket Type Id
user_idintegerNoUser Id
zipstringNoThe zip value

repairshopr_customers_update_portal_users_by_id

Updates an existing Portal User by ID Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesThe id value
contact_idintegerNoContact Id
customer_idintegerNoCustomer Id
emailstringNoThe email value
passwordstringNoThe password value
password_confirmationstringNoPassword Confirmation
portal_group_idintegerNoPortal Group Id