Contacts

Create a contact

post/contacts

Request

  • Base URL: https://www.ruddr.io/api/workspace
  • URL: https://www.ruddr.io/api/workspace/contacts
  • Auth: HTTP bearer

Request body

firstNamestring required

The first name of the contact. Max 127 characters.

lastNamestring required

The last name of the contact. Max 127 characters.

namestring required

The full name of the contact. Max 255 characters.

emailstring required

The email address of the contact. Max 255 characters.

titlestring nullable

The job title of the contact. Max 255 characters.

descriptionstring nullable

A description of the contact. Max 5000 characters.

officePhonestring nullable

The office phone number of the contact. Max 255 characters.

mobilePhonestring nullable

The mobile phone number of the contact. Max 255 characters.

faxstring nullable

The fax number of the contact. Max 255 characters.

websiteUrlstring nullable

The website URL of the contact. Max 255 characters.

ownerIdstring nullable

The identifier of the member who owns this contact.

practiceIdstring nullable

The identifier of the practice associated with the contact.

businessUnitIdstring nullable

The identifier of the business unit associated with the contact.

timeZoneIdstring nullable

The identifier of the time zone for the contact.

tagIdsstring[]

A list of contact tag identifiers to assign to the contact.

Response

200

idstring

The unique identifier for the object.

firstNamestring

The first name of the contact.

lastNamestring

The last name of the contact.

namestring

The full name of the contact.

emailstring

The email address of the contact.

titlestring nullable

The job title of the contact.

descriptionstring nullable

A description of the contact.

officePhonestring nullable

The office phone number of the contact.

mobilePhonestring nullable

The mobile phone number of the contact.

faxstring nullable

The fax number of the contact.

websiteUrlstring nullable

The website URL of the contact.

createdAtstring date-time

The timestamp when the object was created.

createdBystring nullable

The identifier of the member who created the contact.

ownerIdstring nullable

The identifier of the member who owns this contact.

practiceIdstring nullable

The identifier of the practice associated with the contact.

businessUnitIdstring nullable

The identifier of the business unit associated with the contact.

timeZoneIdstring nullable

The identifier of the time zone for the contact.

salesforceIdstring nullable

The Salesforce identifier for the contact.

hubspotIdstring nullable

The HubSpot identifier for the contact.

Changes

No recorded changes to this operation across all 1 revision of this API.