AI-generated Key Takeaways
-
Deletes a contact's photo using the
DELETEmethod and requires sequential requests for the same user. -
Specify the contact using the
resourceNamepath parameter and optionally control returned fields withpersonFieldsandsources. -
Request body should be empty, and the response may include the updated person data if
personFieldsis used. -
Requires the
https://www.googleapis.com/auth/contactsOAuth scope for authorization.
- HTTP request
- Path parameters
- Query parameters
- Request body
- Response body
- Authorization scopes
- Try it!
Delete a contact's photo.
Mutate requests for the same user should be done sequentially to avoid // lock contention.
HTTP request
DELETE https://people.googleapis.com/v1/{resourceName=people/*}:deleteContactPhoto
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters | |
|---|---|
resourceName
|
Required. The resource name of the contact whose photo will be deleted. |
Query parameters
personFields
string (
FieldMask
format)
Optional. A field mask to restrict which fields on the person are returned. Multiple fields can be specified by separating them with commas. Defaults to empty if not set, which will skip the post mutate get. 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 must be empty.
Response body
The response for deleting a contact's photo.
If successful, the response body contains data with the following structure:
| JSON representation |
|---|
{
"person"
:
{
object (
|
| Fields | |
|---|---|
person
|
The updated person, if personFields is set in the DeleteContactPhotoRequest; otherwise this will be unset. |
Authorization scopes
Requires the following OAuth scope:
-
https://www.googleapis.com/auth/contacts
For more information, see the Authorization guide .
