Invite multiple contacts to help center

POST {{baseUrl}}/v1/contacts/inviteAsEndUser

This API helps invite multiple contacts as end-users to your help center.

OAuth Scope

  • Desk.contacts.UPDATE

Attributes

Attribute NameData TypeDescription
contactIds (required)<list>
IDs of the contacts to invite
helpCenterId (required)<long>
ID of the help center to which you want to add the contacts

HEADERS

KeyDatatypeRequiredDescription
Authorizationstring

RESPONSES

status: OK

{&quot;results&quot;:[{&quot;success&quot;:true,&quot;id&quot;:&quot;1892000000093303&quot;,&quot;errors&quot;:null},{&quot;success&quot;:true,&quot;id&quot;:&quot;1892000000085009&quot;,&quot;errors&quot;:null},{&quot;success&quot;:false,&quot;id&quot;:&quot;1892000000050003&quot;,&quot;errors&quot;:{&quot;errorCode&quot;:&quot;UNPROCESSABLE_ENTITY&quot;,&quot;httpCode&quot;:&quot;422&quot;}}]}