close anchor

Contact Groups

To post a contact to a group:

POST /contact/groups

In order to post a contact to a group, log in a user with editor-level privileges. If the group is linked directly to a user group, be a user in that group (or identified with owner-level privileges), too.

Parameters

Provide the input field(s) below as a JSON-encoded data object:

Param Type Description
id string The UUID of the contact.
group string The UUID of the group.

The data object provided by this endpoint is the contact posted to the group.

Errors

If there is an endpoint transaction failure, or a problem with user input data, an error is provided:

ID/Type Description
invalid_group_type The group type is not valid for this endpoint function.

If an error is not described on this page, the platform-wide error table provides further information.

To delete a contact in a group:

DELETE /contact/groups

This endpoint provides for deleting a contact from a group. It will not delete the contact itself, but that contact will no longer be identified with this group.

In order to delete a contact in a group, log in a user with editor-level privileges. If the group is linked directly to a user group, be a user in that group (or identified with owner-level privileges), too.

Parameters

Param Type Description
id string The UUID of the contact.
group string The UUID of the group.

The data object provided by this endpoint is the contact deleted from the group.

Errors

If there is an endpoint transaction failure, or a problem with user input data, an error is provided:

ID/Type Description
invalid_group_type The group type is not valid for this endpoint function.

If an error is not described on this page, the platform-wide error table provides further information.

Register for an Invitation
Thank you!
We'll be in touch.
First Name*
Last Name*
(optional) Business Name
Role*
Email*