Get status of contact in help centers

GET {{baseUrl}}/v1/contacts/:contact_id/helpCenters

This API fetches a particular contact's activation status in all the help centers they are part of.

OAuth Scope

  • Desk.contacts.READ

Request Params

KeyDatatypeRequiredDescription
helpCenterIdstringTo get specific helpcenter info

HEADERS

KeyDatatypeRequiredDescription
Authorizationstring

RESPONSES

status: OK

{"data":[{"helpCenter":{"name":"Zoho","id":"4000000016038","url":"https://help.zoho.com/portal/zoho","status":"ACTIVE"},"userStatus":"ACTIVE","userId":"4000000023791"},{"helpCenter":{"name":"CRM","id":"4000010498403","url":"https://help.zoho.com/portal/crm","status":"ACTIVE"},"userStatus":"ACTIVE","userId":"4000000023791"}]}