POST
/
api
/
v1
/
groups
/
{group_id}
/
contacts
curl --request POST \
  --url https://fulfillment.noyo.com/api/v1/groups/{group_id}/contacts \
  --header 'Content-Type: application/json' \
  --data '{
  "carrier_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "email": "catherine.briggs@example.com",
  "first_name": "Catherine",
  "last_name": "Briggs",
  "phone_number": "+15555551212",
  "primary_contact": true,
  "title": "Engineer",
  "types": [
    "company"
  ]
}'
{
  "created": 1626281253,
  "email": "davidsmith@testcorp.com",
  "first_name": "David",
  "group_id": "2613a221-d3c8-4c8a-86d5-e7e885fd1da9",
  "id": "c2f5489d-36d1-4fb0-bf9f-105ad5dd0b3e",
  "last_name": "Smith",
  "modified": 1626281253,
  "phone_number": "+14255551234",
  "primary_contact": true,
  "title": "Chief People Officer",
  "types": [
    "company",
    "billing"
  ],
  "version": "6ba43c6e-69f2-435f-a126-8595a798eb52"
}

Path Parameters

group_id
string
required

Body

application/json
email
string
required

Work email address of the group contact

first_name
string
required

First name of the group contact

last_name
string
required

Last name of the group contact

types
enum<string>[]
required

List of contact types for the group contact

Available options:
company,
billing,
executive,
online,
carrier
carrier_id
string

Unique identifier of a Carrier in Noyo's system when contact type contains carrier

phone_number
string

Work phone number of the group contact in E.164 format

primary_contact
boolean

True if contact is the primary contact for the group

title
string

Job title of the group contact

Response

201 - application/json
Successful Response - Returns the new Group Contact
created
integer
required

The date the record was originated

group_id
string
required

Unique identifier of the group in Noyo

id
string
required

Unique identifier of the group contact in Noyo

modified
integer
required

The date the record was last updated

types
enum<string>[]
required

List of contact types for the group contact

Available options:
company,
billing,
executive,
online,
carrier
version
string
required

Version of the group contact record

carrier_id
string

Unique identifier of a Carrier in Noyo's system

email
string

Work email address of the group contact

first_name
string

First name of the group contact

last_name
string

Last name of the group contact

phone_number
string

Work phone number of the group contact in E.164 format

primary_contact
boolean

True if contact is the primary contact for the group

title
string

Job title of the group contact