AI-generated Key Takeaways
-
Creates a new contact and returns the person resource.
-
Returns a 400 error if singleton fields (biographies, birthdays, genders, names) have more than one value specified.
-
Requires sequential mutate requests for the same user to avoid latency and failures.
-
Uses the
personFieldsandsources[]query parameters to control data returned. -
Requires the
https://www.googleapis.com/auth/contactsOAuth scope for authorization.
Create a new contact and return the person resource for that contact.
The request returns a 400 error if more than one field is specified on a field that is a singleton for contact sources:
- biographies
- birthdays
- genders
- names
Mutate requests for the same user should be sent sequentially to avoid increased latency and failures.
HTTP request
POST https://people.googleapis.com/v1/people:createContact
The URL uses gRPC Transcoding syntax.
Query parameters
personFields
string (
FieldMask
format)
Required. A field mask to restrict which fields on each person are returned. Multiple fields can be specified by separating them with commas. Defaults to all fields if not set. Valid values are:
- addresses
- ageRanges
- biographies
- birthdays
- calendarUrls
- clientData
- coverPhotos
- emailAddresses
- events
- externalIds
- genders
- imClients
- interests
- locales
- locations
- memberships
- metadata
- miscKeywords
- names
- nicknames
- occupations
- organizations
- phoneNumbers
- photos
- relations
- sipAddresses
- skills
- urls
- userDefined
sources[]
enum (
ReadSourceType
)
Optional. A mask of what source types to return. Defaults to READ_SOURCE_TYPE_CONTACT
and READ_SOURCE_TYPE_PROFILE
if not set.
Request body
The request body contains an instance of Person
.
Response body
If successful, the response body contains an instance of Person
.
Authorization scopes
Requires the following OAuth scope:
-
https://www.googleapis.com/auth/contacts
For more information, see the Authorization guide .
