Contacts

Create or Update Contact

Creates a new contact (recipient) or updates an existing one based on the provided email and phone number combination for the authenticated user.

post/contacts

Request

  • Base URL: https://api.pigeondocuments.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.pigeondocuments.com/contacts
  • Auth: none declared

Request body

first_namestring required

Recipient's first name

last_namestring required

Recipient's last name

emailstring email

Recipient's email address

phonestring

Recipient's phone number. The phone number is expected to be in <a href='https://www.twilio.com/docs/glossary/what-e164' target='_blank'>E.164 format</a> and must include a country code (ie '+1').

language'en-US' | 'es' | 'ar' | 'zh' | 'fr' | 'de' | 'ht' | 'he' | 'id' | 'it' | 'ko' | 'pt' | 'pa' | 'ru'
owner_idstring

ID of user who is making the request. Defaults to currently authenticated user.

Response

Successful Response

idstring required

Unique identifier for the recipient.

first_namestring required

Recipient's first name

last_namestring required

Recipient's last name

emailstring required

Recipient's email address

phonestring required

Recipient's phone number. The phone number is expected to be in <a href='https://www.twilio.com/docs/glossary/what-e164' target='_blank'>E.164 format</a> and must include a country code (ie '+1').

owner_idstring required

ID of the user who owns the recipient.

team_idstring required

ID of the team the recipient is associated with.

language'en-US' | 'es' | 'ar' | 'zh' | 'fr' | 'de' | 'ht' | 'he' | 'id' | 'it' | 'ko' | 'pt' | 'pa' | 'ru'

Changes

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