Hootsuiteconnector v1 | OneTeg Documentation

Version 1

Connector Overview: This page documents all 40 actions for the Hootsuiteconnector v1.

Authentication (2)

GET OAuth2 Authorize

/oauth2/auth

OAuth2 Authorize endpoint.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Accept`	N/A
`Content-type`	N/A
`Response Type`	N/A

Options (4)

Option Name	Description
`Response Type`	N/A
`Client Id`	N/A
`Scope`	N/A
`Redirect Uri`	N/A

POST OAuth2 Token

/oauth2/token

OAuth2 Token endpoint. The required parameters depend on the grant type requested:

Required Parameter	Grant Type
code	authorization_code
redirect_uri	authorization_code
member_id	member_app
organization_id	organization_app
refresh_token	refresh_token

This endpoint requires that you pass in your client credentials using the HTTP Basic authentication scheme as per outlined in the spec.
Including your client credentials in the request-body is not supported.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Accept`	N/A
`Content-type`	N/A
`Authorization`	N/A
`Response Type`	N/A

Options (7)

Option Name	Description
`Grant Type`	N/A
`Code`	N/A
`Redirect Uri`	N/A
`Member Id`	N/A
`Organization Id`	N/A
`Scope`	N/A
`Refresh Token`	N/A

Interactions

GET Get Interactions

/v1/interactions/{socialNetworkType}

Retrieves the interactions between two users of a particular social network type such as direct messages, comments, and posts.

This API is only available to Enterprise users.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Socialnetworktype`	N/A
`Socialnetworkid`	N/A
`Targetsocialnetworkid`	N/A
`Cursor`	N/A
`Limit`	N/A
`Response Type`	N/A

Options (1)

Option Name	Description
`Options`	N/A

Me (3)

GET Retrieve authenticated member

/v1/me

Retrieves authenticated member.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Accept`	N/A
`Content-type`	N/A
`Response Type`	N/A

Options (1)

Option Name	Description
`Options`	N/A

GET Retrieve authenticated member's organizations

/v1/me/organizations

Retrieves the organizations that the authenticated member is in.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Accept`	N/A
`Content-type`	N/A
`Response Type`	N/A

Options (1)

Option Name	Description
`Options`	N/A

GET Retrieve authenticated member's social profiles

/v1/me/socialProfiles

Retrieves the social media profiles that the authenticated user has BASIC_USAGE permissions on.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Accept`	N/A
`Content-type`	N/A
`Response Type`	N/A

Options (1)

Option Name	Description
`Options`	N/A

Media (2)

POST Create media upload url

/v1/media

Creates an Amazon S3 upload URL that can be used to transfer media to Hootsuite which ensures the media is available when a scheduled message is sent to the social network.
Hootsuite will generate thumbnails and key frames and return a unique media identifier that can be passed when creating a message.
Subsequent uploads to an upload URL will be accepted by Amazon but immediately deleted by Hootsuite and only the first valid media file uploaded will be used.
The MIME type and size provided in this call must match the MIME type and size of the media uploaded.

Hootsuite will remove uploaded media 90 days after using the media in a message.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Accept`	N/A
`Content-type`	N/A
`Response Type`	N/A

Options (1)

Option Name	Description
`Options`	N/A

GET Retrieve media upload status

/v1/media/{mediaId}

Retrieves the status of a media upload to Hootsuite.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Mediaid`	N/A
`Accept`	N/A
`Content-type`	N/A
`Response Type`	N/A

Options (1)

Option Name	Description
`Options`	N/A

Members (3)

POST Create member

/v1/members

Creates a member in a Hootsuite organization. Requires organization manage members permission.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Accept`	N/A
`Content-type`	N/A
`Response Type`	N/A

Options (1)

Option Name	Description
`Options`	N/A

GET Retrieve member

/v1/members/{memberId}

Retrieves a member

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Memberid`	N/A
`Accept`	N/A
`Content-type`	N/A
`Response Type`	N/A

Options (1)

Option Name	Description
`Options`	N/A

GET Retrieve member's organizations

/v1/members/{memberId}/organizations

Retrieves the organizations that the member is in.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Memberid`	N/A
`Accept`	N/A
`Content-type`	N/A
`Response Type`	N/A

Options (1)

Option Name	Description
`Options`	N/A

Messages (7)

POST Approve message

/v1/messages/{messageId}/approve

Approve a message.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Messageid`	N/A
`Accept`	N/A
`Content-type`	N/A
`Response Type`	N/A

Options (1)

Option Name	Description
`Options`	N/A

DELETE Delete message

/v1/messages/{messageId}

Deletes a message. A message is always associated with a single social profile.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Messageid`	N/A
`Accept`	N/A
`Content-type`	N/A
`Response Type`	N/A

Options (1)

Option Name	Description
`Options`	N/A

GET Get message review history

/v1/messages/{messageId}/history

Gets a message's prescreening review history.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Messageid`	N/A
`Accept`	N/A
`Content-type`	N/A
`Response Type`	N/A

Options (1)

Option Name	Description
`Options`	N/A

POST Reject message

/v1/messages/{messageId}/reject

Reject a message.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Messageid`	N/A
`Accept`	N/A
`Content-type`	N/A
`Response Type`	N/A

Options (1)

Option Name	Description
`Options`	N/A

GET Retrieve message

/v1/messages/{messageId}

Retrieves a message. A message is always associated with a single social profile. Messages might be unavailable for a brief time during upload to social networks.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Messageid`	N/A
`Accept`	N/A
`Content-type`	N/A
`Response Type`	N/A

Options (1)

Option Name	Description
`Options`	N/A

GET Retrieve outbound messages

/v1/messages

Outbound messages are messages that are scheduled or were previously sent. This endpoint returns outbound messages sorted by increasing scheduled send time. Messages pending approval, including those created by and/or actionable by the given user, will also be returned via this API.

Messages returned can be filtered by social profile or the current state of the message. If more than 50 results are returned a cursor will be automatically created to paginate the results.

Query Parameters must be URL encoded. For example:

?startTime=2020-01-01T00%3A00%3A00Z
&endTime=2020-01-15T17%3A55%3A01Z
&socialProfileIds=1234
&state=SCHEDULED
&limit=5

To specify multiple social profiles, use the following syntax:

?socialProfileIds=1234&socialProfileIds=5678

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Starttime`	N/A
`Endtime`	N/A
`State`	N/A
`Socialprofileids`	N/A
`Limit`	N/A
`Cursor`	N/A
`Includeunscheduledreviewmsgs`	N/A
`Accept`	N/A
`Content-type`	N/A
`Response Type`	N/A

Options (1)

Option Name	Description
`Options`	N/A

POST Schedule messages

/v1/messages

Schedules a message to send on one or more social profiles (except Pinterest). Returns an array of uniquely identifiable messages (one per social profile requested).

Scheduling a message to Pinterest can not be bundled with any other social profiles.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Accept`	N/A
`Content-type`	N/A
`Response Type`	N/A

Options (1)

Option Name	Description
`Options`	N/A

Organizations (7)

DELETE Remove member from organization

/v1/organizations/{organizationId}/members/{memberId}

Removes a member from an organization.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Organizationid`	N/A
`Memberid`	N/A
`Accept`	N/A
`Content-type`	N/A
`Response Type`	N/A

Options (1)

Option Name	Description
`Options`	N/A

GET Retrieve org member's organization permissions

/v1/organizations/{organizationId}/members/{memberId}/permissions

Retrieves an organization member’s permissions for the organization.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Organizationid`	N/A
`Memberid`	N/A
`Accept`	N/A
`Content-type`	N/A
`Response Type`	N/A

Options (1)

Option Name	Description
`Options`	N/A

GET Retrieve org member's teams

/v1/organizations/{organizationId}/members/{memberId}/teams

Retrieves the teams an organization member is in.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Organizationid`	N/A
`Memberid`	N/A
`Accept`	N/A
`Content-type`	N/A
`Response Type`	N/A

Options (1)

Option Name	Description
`Options`	N/A

GET Retrieve org member’s social profile permissions

/v1/organizations/{organizationId}/members/{memberId}/socialProfiles/{socialProfileId}/permissions

Retrieves an organization member’s permissions for a social profile.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Organizationid`	N/A
`Memberid`	N/A
`Socialprofileid`	N/A
`Accept`	N/A
`Content-type`	N/A
`Response Type`	N/A

Options (1)

Option Name	Description
`Options`	N/A

GET Retrieve org member’s social profiles

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Response Type`	N/A

Options (1)

Option Name	Description
`Options`	N/A

GET Retrieve organization members

/v1/organizations/{organizationId}/members

Retrieves the members in an organization

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Organizationid`	N/A
`Accept`	N/A
`Content-type`	N/A
`Response Type`	N/A

Options (1)

Option Name	Description
`Options`	N/A

GET Retrieve organization teams

/v1/organizations/{organizationId}/teams

Retrieves a list of teams for a given organization.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Organizationid`	N/A
`Accept`	N/A
`Content-type`	N/A
`Response Type`	N/A

Options (1)

Option Name	Description
`Options`	N/A

Scim 2.0 (6)

POST Create User

/scim/v2/Users

Creates a Hootsuite user using the SCIM 2.0 protocol.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Accept`	N/A
`Content-type`	N/A
`Response Type`	N/A

Options (1)

Option Name	Description
`Options`	N/A

GET Get Resource Types

/scim/v2/ResourceTypes

Retrieves the configuration for all supported SCIM resource types

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Accept`	N/A
`Content-type`	N/A
`Response Type`	N/A

Options (1)

Option Name	Description
`Options`	N/A

GET Get User

/scim/v2/Users/{memberId}

Retrieves a Hootsuite user using the SCIM 2.0 protocol.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Memberid`	N/A
`Accept`	N/A
`Content-type`	N/A
`Response Type`	N/A

Options (1)

Option Name	Description
`Options`	N/A

GET Get Users

/scim/v2/Users

Retrieves Hootsuite users using the SCIM 2.0 protocol. Support equals filtering on username.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Filter`	N/A
`Count`	N/A
`Startindex`	N/A
`Accept`	N/A
`Content-type`	N/A
`Response Type`	N/A

Options (1)

Option Name	Description
`Options`	N/A

PATCH Modify User

/scim/v2/Users/{memberId}

Modify one or more attributes of a Hootsuite user. For a complete example request, see the SCIM specification.

Limitations:

Currently we only support patching root level attributes with the replace operator
You cannot make modifications to a user after the active attribute has been set to false

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Memberid`	N/A
`Accept`	N/A
`Content-type`	N/A
`Response Type`	N/A

Options (1)

Option Name	Description
`Options`	N/A

PUT Replace User

/scim/v2/Users/{memberId}

Updates a Hootsuite user using the SCIM 2.0 protocol. To see the JSON object attributes required by the PUT endpoint, call the /Schemas endpoint. For a complete example request, see the SCIM specification

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Memberid`	N/A
`Accept`	N/A
`Content-type`	N/A
`Response Type`	N/A

Options (1)

Option Name	Description
`Options`	N/A

GET Retrieve social profile

/v1/socialProfiles/{socialProfileId}

Retrieve a social profile. Requires BASIC_USAGE permission on the social profile.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Socialprofileid`	N/A
`Accept`	N/A
`Content-type`	N/A
`Response Type`	N/A

Options (1)

Option Name	Description
`Options`	N/A

GET Retrieve social profile's teams

/v1/socialProfiles/{socialProfileId}/teams

Retrieves a list of team IDs with access to a social profile. Requires BASIC_USAGE permission on the social profile or ORG_MANAGE_SOCIAL_PROFILE permission on the organization that owns the social profile.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Socialprofileid`	N/A
`Accept`	N/A
`Content-type`	N/A
`Response Type`	N/A

Options (1)

Option Name	Description
`Options`	N/A

GET Retrieve social profiles

/v1/socialProfiles

Retrieves the social profiles that the authenticated user has access to.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Accept`	N/A
`Content-type`	N/A
`Response Type`	N/A

Options (1)

Option Name	Description
`Options`	N/A

Teams (6)

POST Add member to team

/v1/organizations/{organizationId}/teams/{teamId}/members/{memberId}

Adds a member to a team.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Organizationid`	N/A
`Teamid`	N/A
`Memberid`	N/A
`Accept`	N/A
`Content-type`	N/A
`Response Type`	N/A

Options (1)

Option Name	Description
`Options`	N/A

POST Create team

/v1/organizations/{organizationId}/teams

Creates a team in an organization.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Organizationid`	N/A
`Accept`	N/A
`Content-type`	N/A
`Response Type`	N/A

Options (1)

Option Name	Description
`Options`	N/A

GET Retrieve org team’s social profiles

/v1/organizations/{organizationId}/teams/{teamId}/socialProfiles

Retrieves the organization's social profiles that an organization team can access.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Organizationid`	N/A
`Teamid`	N/A
`Accept`	N/A
`Content-type`	N/A
`Response Type`	N/A

Options (1)

Option Name	Description
`Options`	N/A

GET Retrieve team

/v1/teams/{teamId}

Retrieves a team with a given team ID.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Teamid`	N/A
`Accept`	N/A
`Content-type`	N/A
`Response Type`	N/A

Options (1)

Option Name	Description
`Options`	N/A

GET Retrieve team member's permissions

/v1/organizations/{organizationId}/teams/{teamId}/members/{memberId}/permissions

Retrieves team member's team permissions.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Organizationid`	N/A
`Memberid`	N/A
`Teamid`	N/A
`Accept`	N/A
`Content-type`	N/A
`Response Type`	N/A

Options (1)

Option Name	Description
`Options`	N/A

GET Retrieve team members

/v1/organizations/{organizationId}/teams/{teamId}/members

Retrieves the members in a team.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`queryParams`	N/A
`queryParams.Query Param Key`	N/A
`queryParams.Query Param Value`	N/A
`Organizationid`	N/A
`Teamid`	N/A
`Accept`	N/A
`Content-type`	N/A
`Response Type`	N/A

Options (1)

Option Name	Description
`Options`	N/A

Authentication (2)

Interactions

Me (3)

Media (2)

Members (3)

Messages (7)

Organizations (7)

Scim 2.0 (6)

Social Profiles (3)

Teams (6)