Directory API Delivery

SurveyMars 360 Assessment lets you send assessment invitations to raters in your contacts via "Internal Message (API)". Raters receive the message in the enterprise contacts or to-do list and complete the assessment. This option suits enterprise customers who have integrated the Contacts API and want to reach raters without relying on email.

Overview

On the "Distribute" step of a 360 Assessment, besides Email and Password Login, you can also use "Internal Message (API)". This method uses contact details from the rating relationships and pushes invitations through your enabled contacts channel. In Statistics, the source channel for these responses appears as "Contacts API".

Prerequisites

Before you start, make sure all of the following are met. Otherwise, "Internal Message (API)" may not appear on the distribute page, or sending may fail:

1. Your account has Contacts enabled and in use.

2. You have contacted SurveyMars to complete API integration. If it is not enabled, clicking the option prompts you to contact us for setup.

3. In the rating relationship list, "Enable Contacts" is turned on, and ratees and raters are set from contacts.

Note: If Contacts is not enabled, "Internal Message (API)" does not appear on the distribute page.

How to Use

1. Select Internal Message (API)

1. Open the target 360 Assessment and go to "Distribute".

2. In the left "Sending Method" panel, select "Internal Message (API)".

3. After you select it, the rater list on the right no longer shows the email column. The top guidance prompts you to "Edit Internal Message" or "View Send Status" (if you have already sent messages).

Note: Email, Password Login, and Internal Message (API) can be selected together. They are not mutually exclusive, so you can combine methods as needed.

2. Edit and send the internal message

1. Click "Edit Internal Message" in the top guidance to open the internal message editor.

2. In the "Send To" area, raters to be invited appear as tags and are selected by default. Click a tag to exclude that person from this send. You can also use "Deselect All" or invert selection in the upper right to adjust recipients quickly.

3. Set the send time (Send Immediately / Schedule) and contact-related options as needed (such as "Show in To-Do List" and "Anonymous").

4. Review the "Message Content", then click "Send Immediately" (or send according to your schedule).

Note: Deselecting a tag only affects the current send. The next time you open the editor, tags are selected by default again. People who have already completed ratings through other methods are filtered out and do not appear in the pending list. This page does not provide "Add Contact" or "Get Link & QR Code".

3. View send status

1. After sending, click "View Send Status" to open the status page.

2. Filter the contact list by All, Sending, Not Answered, Answered, Failed, and more. You can view name, department, ThirdUserId, email, status, and send time.

3. For failed records, click "Resend" to push again.

4. After raters submit, go to "Statistics" → "View & Download Responses". The "Source Channel" shows "Contacts API", and you can view source channel details and rating relationships.

Configuration Options

- Enable Contacts: A switch on the rating relationship page. Turn it on to show "Internal Message (API)" on the distribute page and to select ratees/raters from contacts.

- Send Time: Supports Send Immediately or Schedule, same as API sending for regular surveys.

- Show in To-Do List: When enabled, the invitation can appear in the contact’s to-do list (for author scenarios in Contacts).

- Anonymous: When enabled, the respondent’s contacts name and department are hidden on submission.

FAQ

Q: Why don’t I see "Internal Message (API)" on the distribute page?

A: Make sure "Enable Contacts" is turned on for rating relationships and that your account uses Contacts. If either condition is missing, the option does not appear.

Q: I clicked "Internal Message (API)" and was told I need to enable the integration. What should I do?

A: This feature requires Contacts API integration first. Contact SurveyMars support or your customer success team to enable it, then try again.

Q: Can I use email sending and API sending at the same time?

A: Yes. Email, Password Login, and Internal Message (API) can be selected together. They are no longer mutually exclusive.

Q: I deselected a rater while editing the internal message. Will they be included next time?

A: Deselecting only applies to the current send. The next time you open the editor, that rater is selected by default again (if they have not finished rating) and can be invited again.

Q: If a rater already responded by email, will they still appear in the API send list?

A: No. People who have completed ratings are filtered out, same as with email sending, to avoid duplicate invitations.