A contact represents an individual. Contacts always belong to an Account.
Contact Fields Overview (JSON | XML schema)
- first_name (required)
- last_name (required)
- title - V.P, President, Manager, etc.
- description - additional information
- owned_by - the ID of the Tripleseat user who owns this contact (see users API)
- account_id - Account ID for this contact
- email_opt_in - opt in for marketing or newsletter emails from you
- contact_type - String (see sites API for values)
- phone_numbers - Nested collection of phone numbers
- email_addresses - Nested collection of email addresses
- addresses - Nested collection of addresses
- custom_fields - Nested collection of Custom Fields
Contact Show / List Endpoints (JSON | XML schema)
GET /v1/contacts.(xml | json)
Retrieves a paginated list of contacts (50 per page, use page parameter to iterate over pages).
GET /v1/contacts/{id}.(xml | json)
Retrieves an contact by its ID.
DELETE /v1/contacts/{id}.(xml | json)
Deletes the contact for the given ID.
GET /v1/contacts/search.(xml | json)?{search params}
Search for contacts using filtering parameters (listed below). Append parameters together using & (e.g., ?query=kevin&sort_direction=desc&order=created_at).
Search Parameters and values
- query - searches by name, account, email, phone
- order - created_at, updated_at, name
- sort_direction - desc, asc
- contact_created_start_date - mm/dd/yyyy (also requires end date)
- contact_created_end_date - mm/dd/yyyy (also requires start date)
- contact_updated_start_date - mm/dd/yyyy (also requires end date)
- contact_updated_end_date - mm/dd/yyyy (also requires start date)
- page - (1..9999999)
Contact Create/Update Endpoints (JSON | XML schema)
POST /v1/contacts.(xml | json)?contact={contact parameters}
Creates a contact using the passed in contact parameters. Parameters are expected to follow the format listed in the JSON/XML schema above.
PUT /v1/contacts/{id}.(xml | json)?contact={contact parameters}
Works just like the create method except you need to pass in the ID of the contact to update.
Comments
0 comments
Article is closed for comments.