Contacts

Contact details

Show details for a contact

Contact Attributes

  • name (string) - The name of the contact
  • email (string) - The email of the contact, must be a valid and deliverable email address
  • address_line_1 (string) - The first line of the contact's address
  • address_line_2 (string) - The second line of the contact's address
  • address_city (string) - The city of the contact's address
  • address_country (string) - The country of the contact's address
  • address_state (string) - The state of the contact's address
  • address_zip (string) - The zip code of the contact's address
  • phone_number (string) - The phone number of the contact
  • business_number (string) - The business phone number of the contact
  • subscribed (boolean) - Whether the contact has opted in to receive marketing communications from the site
  • external_user_id (string) - The external user ID of the contact/customer; this field is only updatable if the contact has been granted an offer or made a purchase
  • created_at (string) - The date and time the contact was created
  • updated_at (string) - The date and time the contact was last updated

Including Relationships

Use the include parameter to include related resources in the response:

  • GET /v1/contacts/123?include=offers,tags,customer

Response will include the related contact offers, tags and customer resources

get/v1/contacts/{id}

Request

Changes

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