Create a group

POST https://:account.api-us1.com/api/3/groups

JSON

{
	"group": {
		"title": "My Groups Title"
	}
}

JSON

{
	"group": {
		"title": "TEST TITLE",
        "descript": "Description Text",
        "unsubscribelink": "0",
        "optinconfirm": "0",
        "pgListAdd": 1,
        "pgListEdit": 1,
        "pgListDelete": 1,
        "pgListHeaders": 1,
        "pgListEmailaccount": 1,
        "pgListBounce": 1,
        "pgMessageAdd": 1,
        "pgMessageEdit": 1,
        "pgMessageDelete": 1,
        "pgMessageSend": 1,
        "pgContactAdd": 1,
        "pgContactEdit": 1,
        "pgContactDelete": 1,
        "pgContactMerge": 1,
        "pgContactImport": 1,
        "pgContactApprove": 1,
        "pgContactExport": 1,
        "pgContactSync": 1,
        "pgContactFilters": 1,
        "pgContactActions": 1,
        "pgContactFields": 1,
        "pg_user_add": "0",
        "pg_user_edit": "0",
        "pg_user_delete": "0",
				"pgGroupAdd": 1,
				"pgGroupEdit": 1,
				"pgGroupDelete": 1,
				"pgTemplateAdd": 1,
        "pgTemplateEdit": 1,
        "pgTemplateDelete": 1,
        "pgPersonalizationAdd": 1,
        "pgPersonalizationEdit": 1,
        "pgPersonalizationDelete": 1,
        "pgAutomationManage": 1,
        "pgFormEdit": 1,
        "pgReportsCampaign": 1,
        "pgReportsList": 1,
        "pgReportsUser": 1,
        "pgReportsTrend": 1,
        "pgStartupReports": 1,
        "pgStartupGettingstarted": 1,
        "pgDeal": 1,
        "pgDealDelete": 1,
        "pgDealReassign": 1,
        "pgDealGroupAdd": 1,
        "pgDealGroupEdit": 1,
        "pgDealGroupDelete": 1,
        "pgSavedResponsesManage": 1,
        "reqApproval": 1,
        "reqApproval1st": 1,
        "reqApprovalNotify": "JohnDoe@gmail.com",
        "socialdata": 0
	}
}

200 OK

{
    "group": {
        "title": "My Groups Title",
        "p_admin": 1,
        "links": {
            "userGroups": "https://:account.api-us1.com/api/:version/groups/7/userGroups",
            "groupLimit": "https://:account.api-us1.com/api/:version/groups/7/groupLimit",
            "dealGroupGroups": "https://:account.api-us1.com/api/:version/groups/7/dealGroupGroups",
            "listGroups": "https://:account.api-us1.com/api/:version/groups/7/listGroups",
            "addressGroups": "https://:account.api-us1.com/api/:version/groups/7/addressGroups",
            "automationGroups": "https://:account.api-us1.com/api/:version/groups/7/automationGroups"
        },
        "id": "7"
    }
}

BODY PARAMS

group

object

group.title REQUIRED

string Title of the group to be created

group.descript

string Group description

group.pgMessageAdd

boolean Permission for adding messages

group.unsubscribelink

boolean Whether or not to force unsubscribe links

group.optinconfirm

boolean Whether or not to force optin confirm for this group

group.pgListAdd

boolean Permission for adding lists

group.pgListEdit

boolean Permission for editing lists

group.pgListDelete

boolean Permission for deleting lists

group.pgListHeaders

boolean Permission for managing custom email headers

group.pgListEmailaccount

boolean Permission for managing Unsubscribe By Email

group.pgListBounce

boolean Permission for accessing list bounce settings

group.pgMessageEdit

boolean Permission for editing messages

group.pgMessageDelete

boolean Permission for deleting messages

group.pgMessageSend

boolean Permission for sending messages

group.pgContactAdd

boolean Permission for adding contacts

group.pgContactEdit

boolean Permission for editing contacts

group.pgContactDelete

boolean Permission for deleting contacts

group.pgContactMerge

boolean Permission for merging contacts

group.pgContactImport

boolean Permission for importing contacts

group.pgContactApprove

boolean Permission for approving contacts

group.pgContactExport

boolean Permission for exporting contacts

group.pgContactSync

boolean Permission for syncing contacts

group.pgContactFilters

boolean Permission for managing contact list segments

group.pgContactActions

boolean Permission for managing contact actions

group.pgContactFields

boolean Permission for managing contact custom fields

group.pg_user_add

boolean Permission for adding users

group.pg_user_edit

boolean Permission for editing users

group.pg_user_delete

boolean Permission for deleting users

group.pgGroupAdd

boolean Permission for adding groups

group.pgGroupEdit

boolean Permission for editing groups

group.pgGroupDelete

boolean Permission for deleting groups

group.pgTemplateAdd

boolean Permission for adding templates

group.pgTemplateEdit

boolean Permission for editing templates

group.pgTemplateDelete

boolean Permission for deleting templates

group.pgPersonalizationAdd

boolean Permission for adding personalization tags

group.pgPersonalizationEdit

boolean Permission for editing personalization tags

group.pgPersonalizationDelete

boolean Permission for deleting personalization tags

group.pgAutomationManage

boolean

group.pgFormEdit

boolean Permission for editing subscription forms

group.pgReportsCampaign

boolean Permission for viewing campaign reports

group.pgReportsList

boolean Permission for viewing list reports

group.pgReportsUser

boolean Permission for viewing user reports

group.pgStartupReports

boolean Campaign ID of last campaign report viewed to decide whether to show link on startup

group.pgReportsTrend

boolean Permission for viewing trend reports

group.pgStartupGettingstarted

boolean Whether or not to show the "getting started" tutorial on overview page

group.pgDeal

boolean Permission for viewing deals

group.pgDealDelete

boolean Permission for deleting deals

group.pgDealReassign

boolean Permission for reassigning deals

group.pgDealGroupAdd

boolean Permission for adding deal groups

group.pgDealGroupEdit

boolean Permission for editing deal groups

group.pgDealGroupDelete

boolean Permission for deleting deals groups

group.pgSavedResponsesManage

boolean Permission for managing saved responses

group.reqApproval

boolean Whether or not this group requires all campaigns to be approved

group.reqApproval1st

boolean Whether or not this group requires first campaign to be approved

group.reqApprovalNotify

string Who to notify for approval related issues (email)

group.socialdata

boolean Whether or not to show social links in campaigns sent from this group

Artikelen in deze sectie

POST https://:account.api-us1.com/api/3/groups

BODY PARAMS

Opmerkingen