Class Persons

searchIterator

let page = 0
for await (const entries of affinity.persons.searchIterator({
    term: 'Alice',
    page_size: 10
})) {
    console.log(`Page ${++page} of entries:`, entries)
}
Copy

create

• create(data): Promise<SimplePersonResponse>

• Creates a new person with the supplied parameters.

  Parameters

  • data: CreatePersonRequest

    Object containing the data for creating a new person

  Returns Promise<SimplePersonResponse>

  The person resource that was just created.

  Example

  const newPerson = await affinity.persons.create({
      first_name: 'Alice',
      last_name: 'Doe',
      emails: ['alice@doe.com'],
      organization_ids: [123456]
  })
  console.log(newPerson)
  Copy

delete

• delete(request): Promise<boolean>

• Deletes a person with a specified person_id.

  Parameters

  • request: PersonReference

  Returns Promise<boolean>

  true if the deletion was successful

  Example

  const success = await affinity.persons.delete({
      person_id: 12345
  })
  console.log(success ? 'Person deleted': 'Person not deleted')
  Copy

get

• get(params): Promise<SinglePersonResponse>

• Fetches a person with a specified person_id.

  Parameters

  • params: GetPersonRequest

  Returns Promise<SinglePersonResponse>

  The person object corresponding to the person_id.

  Example

  const person = await affinity.persons.get({
      person_id: 12345
  })
  console.log(person)
  Copy

getFields

• getFields(): Promise<EntityField[]>

• Fetches an array of all the global fields that exist on persons.

  Returns Promise<EntityField[]>

  An array of the fields that exist on all persons for your team.

  Example

  const personFields = await affinity.persons.getFields()
  console.log(personFields)
  Copy

search

• search(request): Promise<PagedPersonResponse>

• Searches your teams data and fetches all the persons that meet the search criteria.

  This result is paginated. An initial request returns an object with two fields: persons and PagedResponse.next_page_token. persons contains an array of person resources. The value of PagedResponse.next_page_token should be sent as the query parameter page_token in another request to retrieve the next page of results. While paginating through results, each request must have identical query parameters other than the changing page_token. Otherwise, an Invalid page_token variable error will be returned.

  The absence of a PagedResponse.next_page_token indicates that all the records have been fetched, though its presence does not necessarily indicate that there are more resources to be fetched. The next page may be empty (but then PagedResponse.next_page_token would be null to confirm that there are no more resources). Pass {@link InteractionDatesQueryParams.with_interaction_dates}=true as a query parameter to include dates of the most recent and upcoming interactions with persons. When this parameter is included, persons with no interactions will not be returned in the response. Pass with_interaction_persons=true as a query parameter if with_interaction_dates=true to also get the internal persons associated with the interaction. You can filter by interaction dates by providing additional query parameters like min_last_email_date or max_next_event_date. The value of these query parameters should be ISO 8601 formatted date strings.

  Parameters

  • request: SearchPersonsRequest

    Object containing the data for the request

  Returns Promise<PagedPersonResponse>

  Example

  const { persons: allAlices } = await affinity.persons.search({
      term: 'Alice'
  })
  console.log(allAlices)
  Copy

update

• update(data): Promise<SimplePersonResponse>

• Updates an existing person with person_id with the supplied parameters.

  Parameters

  • data: UpdatePersonRequest

    Object containing the data for updating a person

  Returns Promise<SimplePersonResponse>

  The person resource that was just updated.

  Example

  const updatedPerson = await affinity.persons.update({
      person_id: 12345,
      name: 'Acme Corp.',
      person_ids: [38706, 89734]
  })
  console.log(updatedPerson)
  Copy