Pigeon
Dashboard
Dashboard
  1. Contacts
  • Introduction
  • Authentication
  • Integrations
  • Guides
    • Using Third-Party Cloud Storage
  • Requests
    • Requests
    • Create Request
      POST
    • List Requests
      GET
    • Get Request
      GET
    • List Organization Requests
      GET
    • Update Request
      PATCH
    • Delete Request
      DELETE
  • RequestItems
    • Request Items
    • Create Request Item
      POST
    • List Request Items
      GET
    • Get Request Item
      GET
    • Update Request Item
      PATCH
    • Delete Request Item
      DELETE
    • Verify Request Item
      POST
  • Documents
    • Documents
    • Get Document
      GET
    • Delete Document
      DELETE
    • List Request Documents
      GET
    • Delete Request Documents
      DELETE
    • List Request Item Documents
      GET
    • Download Document
      GET
    • Download Request Documents
      GET
    • Download Request Item Documents
      GET
  • Templates
    • Templates
    • List Templates
    • Create Template
    • Get Template
    • Update Template
    • Delete Template
    • List Organization Templates
  • Webhooks
    • Webhooks
    • Create Webhook Subscription
    • List Webhook Subscriptions
    • Get Webhook Subscription
    • Update Webhook Subscription
    • Delete Webhook Subscription
    • Get Webhook Signing Secret
  • Users
    • Get Current User
    • List Users
  • Contacts
    • List Contacts
      GET
    • Create or Update Contact
      POST
    • List Organization Contacts
      GET
  1. Contacts

Create or Update Contact

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

Request

Body Params application/json

Example
{
    "first_name": "string",
    "last_name": "string",
    "email": "user@example.com",
    "phone": "string",
    "language": "en-US",
    "owner_id": "string"
}

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST '/contacts' \
--header 'Content-Type: application/json' \
--data-raw '{
    "first_name": "string",
    "last_name": "string",
    "email": "user@example.com",
    "phone": "string",
    "language": "en-US",
    "owner_id": "string"
}'

Responses

🟢201Created
application/json
Successful Response
Body

Example
{
    "id": "string",
    "first_name": "string",
    "last_name": "string",
    "email": "string",
    "phone": "string",
    "owner_id": "string",
    "language": "en-US"
}
🟠422Parameter Error
Previous
List Contacts
Next
List Organization Contacts