Create or update a contact

Method Details

HTTP Methods:

POST

Content Type:

application/json

Response Format:

json

Requires Authentication?

Yes

Rate Limited?

Headers

Products:

Marketing & CRM

Required Scope:

crm.objects.contacts.write

The create or update a contact endpoint is used to create a new HubSpot contact or update an existing one.

Use case for this endpoint: This method is useful when syncing changes to contacts in other CRMs with your HubSpot contacts.

Response details

If successful, the returned data will include the unique identifier (visitor ID, or vid) of the contact and the request type (create or update).

Returns a 200 response on success. The response will contain a vid of the updated or created record, and an isNew field that indicates if a new record was created. If the field is false, an existing record was updated.
Return a 409 Conflict error response if you are trying to update the email address of a record, and there is an existing record with the new email address.

Need to create or update a large number of contacts? Try the Batch API.

Required parameters	How to use	Description
OAuth access token or private app access token	Authorization: Bearer {token} header	Used to authenticate the request. Please see this page for more details about authentication.
Contact JSON	Used in the request body	This is JSON that represents a contact that you're creating. This should be of the format seen below in the code sample given.

Example URL to POST to: https://api.hubapi.com/contacts/v1/contact/createOrUpdate/email/test@hubspot.com/

Example POST URL: https://api.hubapi.com/contacts/v1/contact/createOrUpdate/email/testingapis@hubspot.com/ Example POST body: The code sample below represents some example JSON with standard properties : { "properties": [ { "property": "firstname", "value": "HubSpot" }, { "property": "lastname", "value": "Test" }, { "property": "website", "value": "http://hubspot.com" }, { "property": "company", "value": "HubSpot" }, { "property": "phone", "value": "555-122-2323" }, { "property": "address", "value": "25 First Street" }, { "property": "city", "value": "Cambridge" }, { "property": "state", "value": "MA" }, { "property": "zip", "value": "02139" } ] } Returns a 200 OK response on success. Example Response data: {"vid":3234574,"isNew":false}

import requests import json url ='https://api.hubapi.com/contacts/v1/contact/createOrUpdate/email/tester123@hubspot.com?hapikey=demo' headers = {} headers['Content-Type']= 'application/json' data=json.dumps({ "properties": [ { "property": "email", "value": "tester123@hubspot.com" }, { "property": "firstname", "value": "test" }, { "property": "lastname", "value": "testerson" }, { "property": "website", "value": "http://updated.example.com" }, { "property": "lifecyclestage", "value": "customer" } ] }) r = requests.post(data=data, url=url, headers=headers) print(r.text)

var request = require("request"); var options = { method: 'POST', url: 'https://api.hubapi.com/contacts/v1/contact/createOrUpdate/email/testingapis@hubspot.com/', qs: { hapikey: 'demo' }, headers: { 'Content-Type': 'application/json' }, body: { properties: [ { property: 'firstname', value: 'HubSpot' }, { property: 'lastname', value: 'Test' }, { property: 'website', value: 'http://hubspot.com' }, { property: 'company', value: 'HubSpot' }, { property: 'phone', value: '555-122-2323' }, { property: 'address', value: '25 First Street' }, { property: 'city', value: 'Cambridge' }, { property: 'state', value: 'MA' }, { property: 'zip', value: '02139' } ] }, json: true }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });