v1Resources/Social Inbox/putUpdate inbox author contact
Update inbox author contact
Requires an active agency user with Social access and Social Inbox enabled. Requires an unrestricted agency owner/admin and unrestricted credential: contacts and vocabulary are shared across clients. Body requires kind, id and at least one profile change. company/occupation: at most 120 characters; description: 2000; email: 254 and valid or empty; phone: 40. Null or empty text clears a field. listIds replaces membership; [] clears it. Unknown agency list IDs are refused. Records the authenticated user; changes may affect the same author across clients. Never sends a message.
put
inbox:write/api/v1/inbox/contactsRequest body
kindstring (comment | message | mention)required
idstringrequired
companystringoptional
occupationstringoptional
descriptionstringoptional
emailobjectoptional
phonestringoptional
listIdsarray of stringoptional
Response
dataobjectoptional
Errors
400The request is missing a required parameter or is otherwise malformed.
401Missing, invalid, expired, or revoked API key.
403The key lacks the required scope, or isn't authorized for this client/location.
404The resource wasn't found, or doesn't belong to your agency.
409The requested change conflicts with the current record.
413More than 2000 items match or belong to expanded threads; narrow the selection.
429Too many requests. Retry after the number of seconds in the Retry-After header.
503The inbox operation could not be completed.
put/api/v1/inbox/contacts
Your API key
Request body*
{}