Youtargets.com API

The Youtargets API is implemented as a PHP page that accepts GET or POST requests and returns JSON or XML.

API clients must hit the URL http://app.youtargets.com/api2.php

All API requests must have a key argument indicating the user, except cmd=login.

CREATING


Methods

MethodExpected parameters

userCreate

userInvite

firstname (type: string, required: Yes, User First Name)
lastname (type: string, User Last Name)
email (type: string, required: Yes, User Email)
message (type: string, Optional message)
admin (type: boolean, User will be Admin, 1 or 0, default: 0)

groupCreate

name (type: string, required: Yes, Group name)

contactCreate

firstname (type: string, required: Yes, The first name of the contact)
lastname (type: string, The last name of the contact)
title (type: string, The title of the contact)
companyid (type: integer, Company Id)
linkedin (type: string, Linkedin profile URL)
twitter (type: string, Twitter username)
facebook (type: string, Facebook profile URL)
gplus (type: string, Google Plus profile URL)
notes (type: string, Contact notes)

contactFilterCreate

companyCreate

name (type: string, required: Yes, Company name)
twitter (type: string, Company twitter account)
notes (type: string, Company notes)

websiteCreate

contactid (type: integer, required: Yes, Contact Id)
companyid (type: integer, required: Yes, Company Id)
address (type: string, required: Yes, Website Url)
type (type: string, Websie type, allowed types: work, personal, other)

emailCreate

contactid (type: integer, required: Yes, Contact Id)
companyid (type: integer, required: Yes, Company Id)
address (type: string, required: Yes, Email Address)
type (type: string, Email type, allowed types: work, home, other)

phoneCreate

contactid (type: integer, required: Yes, Contact Id)
companyid (type: integer, required: Yes, Company Id)
number (type: string, required: Yes, Phone number)
type (type: string, Phone type, allowed types: work, mobile, fax, pager, home, skype, other)

imCreate

contactid (type: integer, required: Yes, Contact Id)
companyid (type: integer, required: Yes, Company Id)
account (type: string, required: Yes, IM account)
network (type: string, required: Yes, IM network, allowed values: aim, msn, icq, jabber, yahoo, skype, gtalk, other)
type (type: string, IM account type, allowed values: work, personal, other)

addressCreate

contactid (type: integer, required: Yes, Contact Id)
companyid (type: integer, required: Yes, Company Id)
street (type: string, required: Yes, Addres Street)
city (type: string, Addres City)
state (type: string, Addres State)
zip (type: string, Addres Zip code)
countryid (type: integer, Country Id (internal))
countrycode (type: string, 2 char Country code)
countryname (type: string, Full Country name)
type (type: string, Address type, allowed values: work, home, other)

dealCreate

name (type: string, required: Yes, Deal name)
contactid (type: integer, Contact Id)
companyid (type: integer, Company Id)
dealcategoryid (type: integer, Deal category Id)
description (type: string, Deal description)
amount (type: double, Deal amount)
currency (type: string, Deal currency)
bidtype (type: string, Deal bid type, allowed values: fixed, hour, month, year)
pending (type: boolean, Deal pending, default: 1)
won (type: boolean, Deal won, default: 0)
lost (type: boolean, Deal lost, default: 0)

dealCategoryCreate

name (type: string, required: Yes, Deal category name)
color (type: string, Deal category hex color)

caseCreate

name (type: string, required: Yes, Case name)
note (type: string, Case background notes)
open (type: boolean, Case open, default: 1)

tagCreate

name (type: string, required: Yes, Tag name)

tagToItemAdd

tagid (type: integer, required: Yes, Tag Id)
subject (type: string, required: Yes, What type of item is the tag attached to, choose from: contact, company, deal, case)
subjectid (type: integer, required: Yes, Subject Id)

taskCreate

name (type: string, required: Yes, Task name)
done (type: integer, Task done, default:0)
taskcategoryid (type: integer, Task category)
contactid (type: integer, Contact id)
companyid (type: integer, Company id)
dealid (type: integer, Deal id)
caseid (type: integer, Case id)
duemonth (type: integer, Due month (used only in conjunction with dueday and dueyear))
dueday (type: integer, Due day (used only in conjunction with duemoth and dueyear))
dueyear (type: integer, Due year)
dueweek (type: integer, Due week (used only in conjunction with dueyear))
duelaterthan (type: integer, Due later than a timestamp)

taskCategoryCreate

name (type: string, required: Yes, Task category name)
color (type: string, Task category hex color)

noteCreate

subject (type: string, required: Yes, What is this note about, choose from: contact, company, deal, case)
subjectid (type: integer, required: Yes, Subject Id)
content (type: string, required: Yes, Note content)

customFieldCreate

name (type: string, required: Yes, Custom field name, alphanumeric)

customFieldValueSet

contactid (type: integer, required: Yes, Contact Id)
companyid (type: integer, required: Yes, Company Id)
fieldname (type: string, required: Yes, Custom field name)
value (type: string, required: Yes, Custom field value)

Introduction

Account

Users

Groups

Contacts

Companies

Websites

Emails

Phones

IMs

Addresses

Deals

Cases

Tags

Tasks

Notes

Custom Fields


LISTING

VIEWING

CREATING

MODIFYING

DELETING


Reference Data

API Wrapper (php)