Create a contact - Givebutter

POST

contacts

Create a contact

curl --request POST \
  --url https://api.givebutter.com/v1/contacts \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "first_name": "<string>",
  "last_name": "<string>",
  "middle_name": "<string>",
  "preferred_name": "<string>",
  "primary_email": "<string>",
  "primary_phone": "<string>",
  "company_name": "<string>",
  "external_id": "<string>",
  "contact_since": "2023-11-07T05:31:56Z",
  "pronouns": "<string>",
  "suffix": "<string>",
  "prefix": "<string>",
  "address_1": "<string>",
  "address_2": "<string>",
  "city": "<string>",
  "state": "<string>",
  "zipcode": "<string>",
  "country": "<string>",
  "primary_address_1": "<string>",
  "primary_address_2": "<string>",
  "primary_city": "<string>",
  "primary_state": "<string>",
  "primary_zipcode": "<string>",
  "primary_country": "<string>",
  "emails": [
    "<string>"
  ],
  "phones": [
    "<string>"
  ],
  "dob": "<string>",
  "employer": "<string>",
  "company": "<string>",
  "title": "<string>",
  "twitter_url": "<string>",
  "linkedin_url": "<string>",
  "facebook_url": "<string>",
  "tiktok_url": "<string>",
  "note": "<string>",
  "email_subscription": true,
  "phone_subscription": true,
  "address_subscription": true,
  "tags": [
    "<string>"
  ],
  "addresses": [
    {
      "address_1": "<string>",
      "address_2": "<string>",
      "city": "<string>",
      "state": "<string>",
      "zipcode": "<string>",
      "country": "<string>"
    }
  ],
  "force_create": false
}
'

{
  "id": "<string>",
  "external_id": "<string>",
  "contact_since": "<string>",
  "type": "<string>",
  "prefix": "<string>",
  "first_name": "<string>",
  "preferred_name": "<string>",
  "middle_name": "<string>",
  "last_name": "<string>",
  "suffix": "<string>",
  "gender": "<string>",
  "pronouns": "<string>",
  "dob": "<string>",
  "company": "<string>",
  "employer": "<string>",
  "company_name": "<string>",
  "title": "<string>",
  "website_url": "<string>",
  "twitter_url": "<string>",
  "linkedin_url": "<string>",
  "facebook_url": "<string>",
  "tiktok_url": "<string>",
  "emails": [
    {
      "type": "<string>",
      "value": "<string>"
    }
  ],
  "phones": [
    {
      "type": "<string>",
      "value": "<string>"
    }
  ],
  "primary_email": "<string>",
  "primary_phone": "<string>",
  "note": "<string>",
  "addresses": [
    {
      "address_1": "<string>",
      "address_2": "<string>",
      "city": "<string>",
      "state": "<string>",
      "zipcode": "<string>",
      "country": "<string>",
      "type": "<string>",
      "is_primary": true,
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "primary_address": {
    "address_1": "<string>",
    "address_2": "<string>",
    "city": "<string>",
    "state": "<string>",
    "zipcode": "<string>",
    "country": "<string>",
    "type": "<string>",
    "is_primary": true,
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  },
  "last_donation_amount": "<string>",
  "stats": {
    "total_contributions": "<string>",
    "recurring_contributions": "<string>"
  },
  "tags": "<string>",
  "custom_fields": [
    "<unknown>"
  ],
  "external_ids": [
    {
      "id": 123,
      "label": "<string>",
      "external_id": "<string>",
      "created_at": "<string>",
      "updated_at": "<string>"
    }
  ],
  "is_email_subscribed": "<string>",
  "is_phone_subscribed": "<string>",
  "is_address_subscribed": "<string>",
  "email_opt_in": "<string>",
  "sms_opt_in": "<string>",
  "address_unsubscribed_at": "<string>",
  "archived_at": "<string>",
  "created_at": "<string>",
  "updated_at": "<string>",
  "salutation_name": "<string>",
  "point_of_contact": {
    "id": "<string>",
    "type": "<string>",
    "prefix": "<string>",
    "first_name": "<string>",
    "middle_name": "<string>",
    "last_name": "<string>",
    "suffix": "<string>",
    "gender": "<string>",
    "pronouns": "<string>",
    "dob": "<string>",
    "employer": "<string>",
    "title": "<string>",
    "twitter_url": "<string>",
    "linkedin_url": "<string>",
    "facebook_url": "<string>",
    "tiktok_url": "<string>",
    "website_url": "<string>",
    "emails": {},
    "phones": {},
    "primary_email": "<string>",
    "primary_phone": "<string>",
    "is_email_subscribed": "<string>",
    "is_phone_subscribed": "<string>",
    "is_address_subscribed": "<string>",
    "address_unsubscribed_at": "<string>",
    "archived_at": "<string>",
    "created_at": "<string>",
    "updated_at": "<string>",
    "first_time_supporter_at": "<string>"
  },
  "associated_companies": [
    {
      "id": "<string>",
      "type": "<string>",
      "company_name": "<string>",
      "name_display": "<string>",
      "title": "<string>",
      "twitter_url": "<string>",
      "linkedin_url": "<string>",
      "facebook_url": "<string>",
      "tiktok_url": "<string>",
      "website_url": "<string>",
      "image_url": "<string>",
      "emails": {},
      "phones": {},
      "primary_email": "<string>",
      "primary_phone": "<string>",
      "is_email_subscribed": "<string>",
      "is_phone_subscribed": "<string>",
      "is_address_subscribed": "<string>",
      "address_unsubscribed_at": "<string>",
      "note": "<string>",
      "addresses": [
        {
          "id": 123,
          "account_id": 123,
          "name": "<string>",
          "address_1": "<string>",
          "address_2": "<string>",
          "city": "<string>",
          "state": "<string>",
          "zipcode": "<string>",
          "country": "<string>",
          "type": "<string>",
          "is_primary": true,
          "created_at": "2023-11-07T05:31:56Z",
          "updated_at": "2023-11-07T05:31:56Z"
        }
      ],
      "primary_address": {
        "id": 123,
        "account_id": 123,
        "name": "<string>",
        "address_1": "<string>",
        "address_2": "<string>",
        "city": "<string>",
        "state": "<string>",
        "zipcode": "<string>",
        "country": "<string>",
        "type": "<string>",
        "is_primary": true,
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z"
      },
      "archived_at": "<string>",
      "created_at": "<string>",
      "updated_at": "<string>",
      "first_time_supporter_at": "<string>"
    }
  ]
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

first_name

string | null

Maximum string length: 255

last_name

string | null

Maximum string length: 255

middle_name

string | null

Maximum string length: 255

preferred_name

string | null

Required string length: 1 - 255

primary_email

string | null

primary_phone

string | null

company_name

string | null

Maximum string length: 255

external_id

string | null

Maximum string length: 255

contact_since

string<date-time> | null

type

enum<string>

Available options:

individual,

company

gender

enum<string>

Available options:

male,

female,

other

pronouns

string | null

Required string length: 1 - 255

suffix

string | null

Maximum string length: 32

prefix

string | null

Maximum string length: 32

address_1

string | null

Maximum string length: 255

address_2

string | null

Maximum string length: 255

city

string | null

Maximum string length: 255

state

string | null

Maximum string length: 255

zipcode

string | null

Maximum string length: 255

country

string | null

primary_address_1

string | null

Maximum string length: 255

primary_address_2

string | null

Maximum string length: 255

primary_city

string | null

Maximum string length: 255

primary_state

string | null

Maximum string length: 255

primary_zipcode

string | null

Maximum string length: 255

primary_country

string | null

emails

string[] | null

phones

string[] | null

dob

string

employer

string | null

Maximum string length: 255

company

string | null

Maximum string length: 255

title

string | null

Maximum string length: 255

twitter_url

string | null

linkedin_url

string | null

facebook_url

string | null

tiktok_url

string | null

note

string | null

email_subscription

boolean | null

phone_subscription

boolean | null

address_subscription

boolean | null

Response

ContactResource

string

required

external_id

string

required

contact_since

string

required

type

string

required

prefix

string

required

first_name

string

required

preferred_name

string

required

middle_name

string

required

last_name

string

required

suffix

string

required

gender

string

required

pronouns

string

required

dob

string

required

company

string

required

employer

string

required

company_name

string

required

title

string

required

website_url

string

required

twitter_url

string

required

linkedin_url

string

required

facebook_url

string

required

tiktok_url

string

required

emails

EmailResource · object[]

required

Show child attributes

phones

PhoneResource · object[]

required

Show child attributes

primary_email

string

required

primary_phone

string

required

note

string

required

addresses

App.Http.Resources.API.AddressResource · object[]

required

Show child attributes

primary_address

App.Http.Resources.API.AddressResource · object

required

Show child attributes

last_donation_amount

string

required

stats

object

required

Show child attributes

tags

string

required

custom_fields

any[]

required

external_ids

ExternalIdResource · object[]

required

Show child attributes

is_email_subscribed

string

required

is_phone_subscribed

string

required

is_address_subscribed

string

required

email_opt_in

string

required

sms_opt_in

string

required

address_unsubscribed_at

string

required

archived_at

string

required

created_at

string

required

updated_at

string

required

salutation_name

string

required

point_of_contact

PointOfContactResource · object

Show child attributes

associated_companies

AssociatedCompanyResource · object[] | null

Show child attributes

Get a contact

⌘I

Create a contact

curl --request POST \
  --url https://api.givebutter.com/v1/contacts \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "first_name": "<string>",
  "last_name": "<string>",
  "middle_name": "<string>",
  "preferred_name": "<string>",
  "primary_email": "<string>",
  "primary_phone": "<string>",
  "company_name": "<string>",
  "external_id": "<string>",
  "contact_since": "2023-11-07T05:31:56Z",
  "pronouns": "<string>",
  "suffix": "<string>",
  "prefix": "<string>",
  "address_1": "<string>",
  "address_2": "<string>",
  "city": "<string>",
  "state": "<string>",
  "zipcode": "<string>",
  "country": "<string>",
  "primary_address_1": "<string>",
  "primary_address_2": "<string>",
  "primary_city": "<string>",
  "primary_state": "<string>",
  "primary_zipcode": "<string>",
  "primary_country": "<string>",
  "emails": [
    "<string>"
  ],
  "phones": [
    "<string>"
  ],
  "dob": "<string>",
  "employer": "<string>",
  "company": "<string>",
  "title": "<string>",
  "twitter_url": "<string>",
  "linkedin_url": "<string>",
  "facebook_url": "<string>",
  "tiktok_url": "<string>",
  "note": "<string>",
  "email_subscription": true,
  "phone_subscription": true,
  "address_subscription": true,
  "tags": [
    "<string>"
  ],
  "addresses": [
    {
      "address_1": "<string>",
      "address_2": "<string>",
      "city": "<string>",
      "state": "<string>",
      "zipcode": "<string>",
      "country": "<string>"
    }
  ],
  "force_create": false
}
'

{
  "id": "<string>",
  "external_id": "<string>",
  "contact_since": "<string>",
  "type": "<string>",
  "prefix": "<string>",
  "first_name": "<string>",
  "preferred_name": "<string>",
  "middle_name": "<string>",
  "last_name": "<string>",
  "suffix": "<string>",
  "gender": "<string>",
  "pronouns": "<string>",
  "dob": "<string>",
  "company": "<string>",
  "employer": "<string>",
  "company_name": "<string>",
  "title": "<string>",
  "website_url": "<string>",
  "twitter_url": "<string>",
  "linkedin_url": "<string>",
  "facebook_url": "<string>",
  "tiktok_url": "<string>",
  "emails": [
    {
      "type": "<string>",
      "value": "<string>"
    }
  ],
  "phones": [
    {
      "type": "<string>",
      "value": "<string>"
    }
  ],
  "primary_email": "<string>",
  "primary_phone": "<string>",
  "note": "<string>",
  "addresses": [
    {
      "address_1": "<string>",
      "address_2": "<string>",
      "city": "<string>",
      "state": "<string>",
      "zipcode": "<string>",
      "country": "<string>",
      "type": "<string>",
      "is_primary": true,
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "primary_address": {
    "address_1": "<string>",
    "address_2": "<string>",
    "city": "<string>",
    "state": "<string>",
    "zipcode": "<string>",
    "country": "<string>",
    "type": "<string>",
    "is_primary": true,
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  },
  "last_donation_amount": "<string>",
  "stats": {
    "total_contributions": "<string>",
    "recurring_contributions": "<string>"
  },
  "tags": "<string>",
  "custom_fields": [
    "<unknown>"
  ],
  "external_ids": [
    {
      "id": 123,
      "label": "<string>",
      "external_id": "<string>",
      "created_at": "<string>",
      "updated_at": "<string>"
    }
  ],
  "is_email_subscribed": "<string>",
  "is_phone_subscribed": "<string>",
  "is_address_subscribed": "<string>",
  "email_opt_in": "<string>",
  "sms_opt_in": "<string>",
  "address_unsubscribed_at": "<string>",
  "archived_at": "<string>",
  "created_at": "<string>",
  "updated_at": "<string>",
  "salutation_name": "<string>",
  "point_of_contact": {
    "id": "<string>",
    "type": "<string>",
    "prefix": "<string>",
    "first_name": "<string>",
    "middle_name": "<string>",
    "last_name": "<string>",
    "suffix": "<string>",
    "gender": "<string>",
    "pronouns": "<string>",
    "dob": "<string>",
    "employer": "<string>",
    "title": "<string>",
    "twitter_url": "<string>",
    "linkedin_url": "<string>",
    "facebook_url": "<string>",
    "tiktok_url": "<string>",
    "website_url": "<string>",
    "emails": {},
    "phones": {},
    "primary_email": "<string>",
    "primary_phone": "<string>",
    "is_email_subscribed": "<string>",
    "is_phone_subscribed": "<string>",
    "is_address_subscribed": "<string>",
    "address_unsubscribed_at": "<string>",
    "archived_at": "<string>",
    "created_at": "<string>",
    "updated_at": "<string>",
    "first_time_supporter_at": "<string>"
  },
  "associated_companies": [
    {
      "id": "<string>",
      "type": "<string>",
      "company_name": "<string>",
      "name_display": "<string>",
      "title": "<string>",
      "twitter_url": "<string>",
      "linkedin_url": "<string>",
      "facebook_url": "<string>",
      "tiktok_url": "<string>",
      "website_url": "<string>",
      "image_url": "<string>",
      "emails": {},
      "phones": {},
      "primary_email": "<string>",
      "primary_phone": "<string>",
      "is_email_subscribed": "<string>",
      "is_phone_subscribed": "<string>",
      "is_address_subscribed": "<string>",
      "address_unsubscribed_at": "<string>",
      "note": "<string>",
      "addresses": [
        {
          "id": 123,
          "account_id": 123,
          "name": "<string>",
          "address_1": "<string>",
          "address_2": "<string>",
          "city": "<string>",
          "state": "<string>",
          "zipcode": "<string>",
          "country": "<string>",
          "type": "<string>",
          "is_primary": true,
          "created_at": "2023-11-07T05:31:56Z",
          "updated_at": "2023-11-07T05:31:56Z"
        }
      ],
      "primary_address": {
        "id": 123,
        "account_id": 123,
        "name": "<string>",
        "address_1": "<string>",
        "address_2": "<string>",
        "city": "<string>",
        "state": "<string>",
        "zipcode": "<string>",
        "country": "<string>",
        "type": "<string>",
        "is_primary": true,
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z"
      },
      "archived_at": "<string>",
      "created_at": "<string>",
      "updated_at": "<string>",
      "first_time_supporter_at": "<string>"
    }
  ]
}

Documentation Index

Authorizations

Body

Response