ConnectYard OAuth 3-legged API

• Message Actions

  • List Methods
  • Expand Methods

  • GETGet Message Home Timeline/v1/messages/home
    Will return the most recent messages that the user has received across all their yards.
    
    

    Parameter	Value	Type	Description
    show_markup	01	enumerated	Determines whether message returned to ConnectYard contains the HTML markup. Includes <a> anchor tags, <br/> line breaks, and <p> paragraph tags 0 Send message in plaintext. 1 Send message with HTML markup
    max_id		string	Will return messages with id less than or equal to the given id.
    min_id		string	Will return messages with id greater than or equal to the given id.
    count		string	Will return specified number of messages. Max value: 50

  • GETGet Message Yard Timeline/v1/messages/yards/:yard_id
    Will return the most recent messages that the user has received for a specific yard.
    
    

    Parameter	Value	Type	Description
    yard_id		string	Id of the yard to view.
    show_markup	01	enumerated	Determines whether message returned to ConnectYard contains the HTML markup. Includes <a> anchor tags, <br/> line breaks, and <p> paragraph tags 0 Send message in plaintext. 1 Send message with HTML markup
    max_id		string	Will return messages with id less than or equal to the given id.
    min_id		string	Will return messages with id greater than or equal to the given id.
    count		string	Will return specified number of messages. Max value: 50

  • GETGet Single Message/v1/messages/:message_id
    Will return the specified message.
    
    

    Parameter	Value	Type	Description
    message_id		string	Id of the message to load up.
    show_markup	01	enumerated	Determines whether message returned to ConnectYard contains the HTML markup. Includes <a> anchor tags, <br/> line breaks, and <p> paragraph tags 0 Send message in plaintext. 1 Send message with HTML markup

  • GETGet Message Likes/v1/messages/:message_id/likes
    Will return information on the users who liked the selected message.
    
    

    Parameter	Value	Type	Description
    message_id		string	Id for the messages to retrieve likes.

  • GETGet Message Follows/v1/messages/:message_id/follows
    Will return information on the users who are following the selected message.
    
    

    Parameter	Value	Type	Description
    message_id		string	Id for the messages to retrieve likes.

  • GETGet Message Views/v1/messages/:message_id/views
    Will return information on the users who have viewed the selected message.
    
    

    Parameter	Value	Type	Description
    message_id		string	Id for the messages to retrieve views.

  • GETGet Message UnViewed/v1/messages/:message_id/unviewed
    Will return information on the users who have not viewed the selected message.
    
    

    Parameter	Value	Type	Description
    message_id		string	Id for the messages to retrieve unviewed users.

  • GETGet Message Attachment/v1/messages/attachments/:attachment_id
    Will return the URL and information on the selected attachment. This URL is good for 30 seconds.
    
    

    Parameter	Value	Type	Description
    attachment_id		string	Id for the attachment to retrieve.

  • POSTLike Message/v1/messages/:message_id/likes
    Like a message that the user can view.
    
    

    Parameter	Value	Type	Description
    message_id		int	Id of the post user wishes to like.

  • POSTFollow Message/v1/messages/:message_id/follows
    Follow a message that the user can view.
    
    

    Parameter	Value	Type	Description
    message_id		int	Id of the post user wishes to follow.

  • POSTView Message/v1/messages/:message_id/views
    Register a view for the message.
    
    

    Parameter	Value	Type	Description
    message_id		int	Id of the post user wishes to view.

  • POSTResend Message Notifications/v1/messages/:message_id/resend
    Resend notifications to selected users. Notifications can only be sent to users that are members of the yard or have been mentioned.
    
    

    Parameter	Value	Type	Description
    message_id		int	Id of the post user wishes to view.
    resend_uids		string	Keyword 'unviewed' or comma-seperated list of user ids to resend notifications. 'unviewed' will send notifications to the current list of unviewed users. Supplying a list of user ids that notifications will be resent to, this list will only resend to members or mentioned users.
    urgent	01	enumerated	Determine whether to send notifications as urgent instead of standard. If unset will default to 0. 0 Send as standard. Notifications will be send to selected users based on their Yard or Mention preferences. 1 Send as urgent. Notifications will be sent to selected users across all channels, no matter their notification settings.

  • POSTPost Message/v1/messages/yards/:yard_id
    Allows users to post messages into a yard they are a member of. Restrictions: Admin setting 'member_post' being set to 0 for the yard will only allow admins to post new messages.
    
    

    Parameter	Value	Type	Description
    yard_id		int	Yard the message is to be posted into.
    message_text		string	Text data of the message.
    custom_tags		string	JSON-encoded Key:Value pairs for customizable settings storing custom data per message. LIMITATIONS: 5 key pairs, key length up to 16 characters, and value length up to 32 characters. Any extra pairs or those that exceed the limit will be discarded.
    silent	01	enumerated	If silent and urgent are both set to 1, urgent takes precedence. If unset will default to 0. 0 Do not send as silent. 1 Send as silent.
    urgent	01	enumerated	User must be a Community Admin to post as urgent. If set, and not a Community Admin, it will be ignored. If unset will default to 0. 0 Do not send as urgent. 1 Send as urgent. Notifications will be sent to all yard users across all channels, no matter their notification settings.
    social_media_page_post	01	enumerated	User must be an admin to publish a message to a Facebook page or Twitter feed. When this parameter is omitted, the default value is determined by the yard setting social_media_page_default_post. 0 Do not publish to linked Facebook pages or Twitter feeds. 1 Publish to linked Facebook pages or Twitter feeds.

  • DELETEUnlike Message/v1/messages/:message_id/likes
    Allows users to unlike a post they are currently liking.
    
    

    Parameter	Value	Type	Description
    message_id		int	Id for the message to be unliked.

  • DELETEUnfollow Message/v1/messages/:message_id/follows
    Allows users to unfollow a post they are currently following.
    
    

    Parameter	Value	Type	Description
    message_id		int	Id for the message to be unfollowed.

  • DELETEDelete Message/v1/messages/:message_id
    Allow users and admins to delete messages. This will completely delete the message, its replies and comments, and its message specific statistics (Views, Likes, Follows). Restrictions: Admin setting 'member_delete_post' being set to 1 for the yard will allow users to delete their own posts.
    
    

    Parameter	Value	Type	Description
    message_id		int	Id for the message to be deleted.

  • GETGet Community Messages Timeline/v1/messages/community
    This method requires the requesting user to be a Community Admin to return the most recent messages for the current community.
    
    

    Parameter	Value	Type	Description
    show_markup	01	enumerated	Determines whether message returned to ConnectYard contains the HTML markup. Includes <a> anchor tags, <br/> line breaks, and <p> paragraph tags 0 Send message in plaintext. 1 Send message with HTML markup
    max_id		string	Will return messages with id less than or equal to the given id.
    min_id		string	Will return messages with id greater than or equal to the given id.
    count		string	Will return specified number of messages. Max value: 50

• Reply/Comment Actions

  • List Methods
  • Expand Methods

  • GETGet Replies Home Timeline/v1/messages/replies/home
    Will return the most recent Replies that the user has received across all their yards.
    
    

    Parameter	Value	Type	Description
    show_markup	01	enumerated	Determines whether message returned to ConnectYard contains the HTML markup. Includes <a> anchor tags, <br/> line breaks, and <p> paragraph tags 0 Send message in plaintext. 1 Send message with HTML markup
    max_id		string	Will return messages with id less than or equal to the given id.
    min_id		string	Will return messages with id greater than or equal to the given id.
    count		string	Will return specified number of messages. Max value: 50

  • GETGet Replies Yard Timeline/v1/messages/replies/yards/:yard_id
    Will return the most recent replies that the user has received for a specific yard.
    
    

    Parameter	Value	Type	Description
    yard_id		string	Id for the yard to retrieve replies.
    show_markup	01	enumerated	Determines whether message returned to ConnectYard contains the HTML markup. Includes <a> anchor tags, <br/> line breaks, and <p> paragraph tags 0 Send message in plaintext. 1 Send message with HTML markup
    max_id		string	Will return messages with id less than or equal to the given id.
    min_id		string	Will return messages with id greater than or equal to the given id.
    count		string	Will return specified number of messages. Max value: 50

  • GETGet Single Message Replies/v1/messages/:message_id/replies
    Will return the replies and comments to the specified message in chronological order (Newest to Oldest).
    
    

    Parameter	Value	Type	Description
    message_id		string	Id of the message to load up the replies.
    show_markup	01	enumerated	Determines whether message returned to ConnectYard contains the HTML markup. Includes <a> anchor tags, <br/> line breaks, and <p> paragraph tags 0 Send message in plaintext. 1 Send message with HTML markup
    max_id		string	Will return messages with id less than or equal to the given id.
    min_id		string	Will return messages with id greater than or equal to the given id.
    count		string	Will return specified number of messages. Max value: 50

  • GETGet Single Message Replies with Nested Comments/v1/messages/:message_id/repliescomments
    Will return the replies with comments nested in each reply to the specified message in chronological order (Newest to Oldest) for replies.
    
    

    Parameter	Value	Type	Description
    message_id		string	Id of the message to load up the replies.
    show_markup	01	enumerated	Determines whether message returned to ConnectYard contains the HTML markup. Includes <a> anchor tags, <br/> line breaks, and <p> paragraph tags 0 Send message in plaintext. 1 Send message with HTML markup
    max_id		string	Will return messages with id less than or equal to the given id.
    min_id		string	Will return messages with id greater than or equal to the given id.
    count		string	Will return specified number of messages. Max value: 50

  • GETGet Reply Likes/v1/messages/replies/:reply_id/likes
    Will return information on the users who liked the selected reply.
    
    

    Parameter	Value	Type	Description
    reply_id		string	Id for the reply to retrieve likes.

  • GETGet Reply Attachment/v1/messages/replies/attachments/:attachment_id
    Will return the URL and information on the selected attachment. This URL is good for 30 seconds.
    
    

    Parameter	Value	Type	Description
    attachment_id		string	Id for the attachment to retrieve.

  • POSTLike Reply/v1/messages/replies/:reply_id/likes
    Like a reply that the user can view.
    
    

    Parameter	Value	Type	Description
    reply_id		int	Id of the reply user wishes to like.

  • POSTPost Reply/v1/messages/:message_id
    Allows users to post replies to messages they can see. Will allow for replies to messages in a yard the user is a member of and also messages the user is mentioned in. Restrictions: Admin setting 'member_reply' being set to 0 for the yard will only allow admins to post replies.
    
    

    Parameter	Value	Type	Description
    message_id		int	Id of the message user wishes to post a reply to.
    message_text		string	Text data of the reply.
    custom_tags		string	JSON-encoded Key:Value pairs for customizable settings storing custom data per message. LIMITATIONS: 5 key pairs, key length up to 16 characters, and value length up to 32 characters. Any extra pairs or those that exceed the limit will be discarded.
    silent	01	enumerated	If silent and urgent are both set to 1, urgent takes precedence. If unset will default to 0. 0 Do not send as silent. 1 Send as silent.
    urgent	01	enumerated	User must be a Community Admin to post as urgent. If set, and not a Community Admin, it will be ignored. If unset will default to 0. 0 Do not send as urgent. 1 Send as urgent. Notifications will be sent to all yard users across all channels, no matter their notification settings.

  • POSTPost Comment/v1/messages/replies/:reply_id
    Allows users to post comments to replies they can see. Will allow for comments to replies in a yard the user is a member of and also messages the user is mentioned in. If yard setting (member_reply) is set to '0' only yard & community admins can post.
    
    

    Parameter	Value	Type	Description
    reply_id		int	Id of the reply user wishes to post a comment to.
    message_text		string	Text data of the comment.
    custom_tags		string	JSON-encoded Key:Value pairs for customizable settings storing custom data per message. LIMITATIONS: 5 key pairs, key length up to 16 characters, and value length up to 32 characters. Any extra pairs or those that exceed the limit will be discarded.
    silent	01	enumerated	If silent and urgent are both set to 1, urgent takes precedence. If unset will default to 0. 0 Do not send as silent. 1 Send as silent.
    urgent	01	enumerated	User must be a Community Admin to post as urgent. If set, and not a Community Admin, it will be ignored. If unset will default to 0. 0 Do not send as urgent. 1 Send as urgent. Notifications will be sent to all yard users across all channels, no matter their notification settings.

  • DELETEDelete Reply/Comment/v1/messages/replies/:reply_id
    Allow users and admins to delete replies/comments. This will completely delete the reply/comment and its associated likes. Restrictions: Admin setting 'member_delete_post' being set to 1 for the yard will allow users to delete their own replies/comments.
    
    

    Parameter	Value	Type	Description
    reply_id		int	Id for the reply or comment to be deleted.

  • DELETEUnlike Reply/Comment/v1/messages/replies/:reply_id/likes
    Allows users to unlike a reply/comment they are currently liking.
    
    

    Parameter	Value	Type	Description
    reply_id		int	Id for the reply/comment to be unliked.

  • GETGet Community Replies Timeline/v1/messages/replies/community
    This method requires the requesting user to be a Community Admin to return the most recent replies for the current community.
    
    

    Parameter	Value	Type	Description
    show_markup	01	enumerated	Determines whether message returned to ConnectYard contains the HTML markup. Includes <a> anchor tags, <br/> line breaks, and <p> paragraph tags 0 Send message in plaintext. 1 Send message with HTML markup
    max_id		string	Will return messages with id less than or equal to the given id.
    min_id		string	Will return messages with id greater than or equal to the given id.
    count		string	Will return specified number of messages. Max value: 50

• Wall Post Actions

  • List Methods
  • Expand Methods

  • GETGet Wall Posts/v1/users/:user_id/wallposts
    Retrieve a list of your current wall posts or view other users wall posts visible to user.
    
    

    Parameter	Value	Type	Description
    user_id		string	Id for the user to be looked up.
    show_markup	01	enumerated	Determines whether wall posts returned to ConnectYard contains the HTML markup. Includes <a> anchor tags, <br/> line breaks, and <p> paragraph tags 0 Send wall post in plaintext. 1 Send wall post with HTML markup
    max_id		string	Will return wall posts with id less than or equal to the given id.
    min_id		string	Will return wall posts with id greater than or equal to the given id.
    count		string	Will return specified number of wall posts. Max value: 50

  • GETGet Wall-to-Wall Posts/v1/users/:user_id/walltowall
    Retrieve a the wall-to-wall view of posts between yourself and selected user. This will include both your posts and their posts list in order from most recent post.
    
    

    Parameter	Value	Type	Description
    user_id		string	Id for the user to be looked up.
    second_user_id		string	Id for the second user to be looked up.
    show_markup	01	enumerated	Determines whether wall posts returned to ConnectYard contains the HTML markup. Includes <a> anchor tags, <br/> line breaks, and <p> paragraph tags 0 Send wall post in plaintext. 1 Send wall post with HTML markup
    max_id		string	Will return wall posts with id less than or equal to the given id.
    min_id		string	Will return wall posts with id greater than or equal to the given id.
    count		string	Will return specified number of wall posts. Max value: 50

  • GETGet Community Wall Posts Timeline/v1/users/wallposts/community
    This method requires the requesting user to be a Community Admin to return the most recent wall posts for the current community.
    
    

    Parameter	Value	Type	Description
    show_markup	01	enumerated	Determines whether wall posts returned to ConnectYard contains the HTML markup. Includes <a> anchor tags, <br/> line breaks, and <p> paragraph tags 0 Send wall post in plaintext. 1 Send wall post with HTML markup
    max_id		string	Will return wall posts with id less than or equal to the given id.
    min_id		string	Will return wall posts with id greater than or equal to the given id.
    count		string	Will return specified number of wall posts. Max value: 50

  • GETGet Wall Post Attachment/v1/users/~/wallposts/attachments/:attachment_id
    Will return the URL and information on the selected attachment. This URL is good for 30 seconds.
    
    

    Parameter	Value	Type	Description
    attachment_id		string	Id for the attachment to retrieve.

  • POSTPost to Wall/v1/users/:user_id/wallposts
    Allows users to post comments to replies they can see. Will allow for comments to replies in a yard the user is a member of and also messages the user is mentioned in.
    
    

    Parameter	Value	Type	Description
    user_id		int	Id of the user whose wall you wish to post.
    message_text		string	Text data of the wallpost.
    custom_tags		string	JSON-encoded Key:Value pairs for customizable settings storing custom data per message. LIMITATIONS: 5 key pairs, key length up to 16 characters, and value length up to 32 characters. Any extra pairs or those that exceed the character limits will be discarded. JSON syntax is not included in the character limit.
    private	01	enumerated	Setting to flag a wallpost as private, otherwise it will be public. If not set, will default to private. 0 Wallpost is public. 1 Wallpost is private.

  • DELETEDelete Wallpost/v1/users/wallposts/:message_id
    Allows users to remove posts from their wall.
    
    

    Parameter	Value	Type	Description
    message_id		int	Id for the wallpost to be deleted.

• Yard Actions

  • List Methods
  • Expand Methods

  • GETGet Yard List/v1/users/~/yards
    Lookup the yard list for the current user.
    
    
  • GETGet Yard Members/v1/yards/:yard_id/users
    Will return the members of the yard and their role.
    
    

    Parameter	Value	Type	Description
    yard_id		string	Id of the yard to view.
    count		string	Will return specified number of Users. Max value: 100
    offset		string	Will offset the count by specified number. Mainly used to traverse the users.
    search_name		string	Only return names that contain the specified string.
    status	10	enumerated	Returns enabled or disabled user accounts. Will default show enabled accounts if not provided. 0 Show disabled user accounts. 1 Show enabled user accounts.

  • GETGet Yard Info/v1/yards/:yard_id
    Lookup yard information for specified yard.
    
    

    Parameter	Value	Type	Description
    yard_id		string	Id or course code of the yard to view. Course Codes must be URL encoded, failure to URL encode can result in invalid lookups.
    is_course_code	01	enumerated	If a course code is a numeric value, you must set this flag to 1 otherwise it will be interpreted as a yard id instead of a course code lookup. 0 Yard Id is not a course code 1 Yard Id is a course code.

  • GETGenerate Yard Report/v1/yards/:yard_id/reports
    Generate reporting data for specified yard.
    
    

    Parameter	Value	Type	Description
    yard_id		string	Id of the yard to view.
    start_time		string	Start Time for report.
    end_time		string	End Time for report.

  • GETGenerate Engagement Score Report/v1/yards/:yard_id/userreports
    Generate report of user engagement score for specified yard.
    
    

    Parameter	Value	Type	Description
    yard_id		string	Id of the yard to view.
    start_time		string	Start Time for report.
    end_time		string	End Time for report.

  • POSTCreate Yard/v1/yards
    This method can always be executed by the Community Admin.
    
    

    Parameter	Value	Type	Description
    yard_name		string	Name of the yard to be created.
    unique_id		string	Unique identifier for the yard being created. This must be unique within your community otherwise it will return an error.
    access	privatepublic	enumerated	Visibility level of the yard. If unset will default to private. private Yard is only visible to members of the yard. public All users in the community are able to see this yard and request to join.
    parent_yard_id		int	Link newly created yard to an already existing yard.

  • POSTEnroll User/v1/yards/:yard_id/users/:user_id
    Allow users to invite other users into their yards.
    
    

    Parameter	Value	Type	Description
    yard_id		int	Yard user is to be enrolled into.
    user_id		int	User being enrolled into the yard.
    role	memberadmin	enumerated	The role the newly enrolled user will have. If unset will default to member. member User enrolled as a member type. admin User enrolled as a yard admin. Only yard admins & community admins have the ability to enroll a user as an admin.
    send_welcome_mail	01	enumerated	Send Welcome e-mail to new user. 0 Do Not Send Welcome E-mail. 1 Send Welcome E-mail.
    welcome_mail_from		int	Specify the ID of the user to send the welcome e-mail as.
    welcome_mail_template_id		int	Specify the ID of the template to use.

  • POSTSet Admin Settings/v1/yards/:yard_id/settings
    Allow yard admins to configure the settings for their yards.
    
    

    Parameter	Value	Type	Description
    yard_id		int	YardId of the yard the settings will be updated.
    anonymous_post	01	enumerated	Set whether members can post anonymously. 0 Cannot post anonymously. 1 Can post anonymously.
    member_post	01	enumerated	Set whether members can post in the yard. 0 Cannot post. 1 Can post.
    member_reply	01	enumerated	Set whether members can reply to posts in the yard. 0 Cannot reply. 1 Can reply.
    join_no_admin	01	enumerated	Set whether new users can join without admin approval. 0 Cannot join without admin approval. 1 Can join without admin approval.
    member_delete_post	01	enumerated	Set whether users can delete their own posts. 0 Cannot delete own posts. 1 Can delete own post.
    allow_member_invite	01	enumerated	Set whether to allow members to be allowed to invite others. 0 Members cannot invite. 1 Members can invite.
    member_see_view	01	enumerated	Set whether members can see the view count of posts. 0 Cannot see views. 1 Can see views.
    facebook_public_post	01	enumerated	Set whether notifications sent to Facebook are "public" or "private". Setting this option to 1 (public) will actually send a portion of the message text in a Facebook notification to the user's notifications center. These notifications are not visible on a user's Facebook profile or newsfeed. Since notifications posted to Facebook are stored on Facebook's servers, if data security is a concern, the recommended option is to set this option to 0 (private), which will only display the poster's name and the name of the yard in which they posted. 0 Notifications are sent as private. 1 Notifications are sent as public.
    tw_public_post	01	enumerated	Set whether notifications sent to Twitter are "public" or "private". Setting this option to 1 (public) will actually send a portion of the message text within the tweet. Since messages posted to Twitter are stored on Twitter's servers and are globally visible, if data security is a concern, the recommended option is to set this option to 0 (private), which will only provide a link back to the message in ConnectYard in the tweet. 0 Notifications are sent as private. 1 Notifications are sent as public.
    email_notification	01	enumerated	Set whether members can opt out of e-mail notifications. 0 Do not allow members to opt-out of e-mail notifications. 1 Allow members to opt-out of e-mail notifications.
    access	privatepublic	enumerated	Set yard visibility. private Yard is only visible to members of the yard. public All users in the community are able to see this yard and request to join.
    yard_daily_news	01	enumerated	Set yard visibility. 0 Messages for yard will not show up in users daily summary. 1 Daily Summary will include messages from yard.
    attachment_public	01	enumerated	By default, attachment links included in notifications include a 24-hour token which allows the user to download the attachment without having to be logged in. By setting this setting to 1, users will be able to use the download link without having to log in past the 24 hour period. Keeping this setting set to 0 will prompt users to log in after clicking the download link after 24 hours have passed. 0 Attachment downloads must be authenticated. 1 Attachments can be downloaded without authentication.
    attachment_allow	01	enumerated	By default, users are allowed to post attachments. 0 Members are not allowed to post attachments. 1 Members can not post attachments.
    facebook_enabled	01	enumerated	Sets whether Facebook notifications can be sent to yard members. Setting this to 0 effectively disables Facebook as a channel for the yard. Users will still be able to view messages within the ConnectYard Facebook application, but they will not receive any Facebook notifications. 0 Facebook notifications are disabled for the yard. 1 Facebook notifications are enabled for the yard.
    twitter_enabled	01	enumerated	Sets whether Twitter notifications can be sent to yard members. Setting this to 0 effectively disables Twitter as a channel for the yard. 0 Twitter notifications are disabled for the yard. 1 Twitter notifications are enabled for the yard.
    whatsapp_enabled	01	enumerated	Sets whether WhatsApp notifications can be sent to yard members. Setting this to 0 effectively disables WhatsApp as a channel for the yard. 0 WhatsApp notifications are disabled for the yard. 1 WhatsApp notifications are enabled for the yard.
    text_enabled	01	enumerated	Sets whether text message notifications can be sent to yard members. Setting this to 0 effectively disables text messaging as a channel for the yard. 0 Text message notifications are disabled for the yard. 1 Text message notifications are enabled for the yard.
    mail_enabled	01	enumerated	Sets whether e-mail notifications can be sent to yard members. Setting this to 0 effectively disables e-mail as a channel for the yard. 0 E-mail notifications are disabled for the yard. 1 E-mail notifications are enabled for the yard.
    altemail_public_post	01	enumerated	Set whether e-mail notifications sent to alternate e-mail addresses (which could be hosted on google or yahoo, for example) are "public" or "private". Setting this option to 1 (public) will actually send the message text within the e-mail notification. If data security is a concern, the recommended option is to set this option to 0 (private), which will only provide a link back to the message in ConnectYard in the e-mail notification. 0 Notifications sent to alternate e-mail addresses are sent as private. 1 Notifications sent to alternate e-mail addresses are sent as public.
    social_media_page_default_post	01	enumerated	If a social media page, such as a Facebook page or Twitter feed, is linked to a yard, this setting will determine if posts made in the yard are by default published to those pages. 0 Messages are not published to a social media page by default. 1 Messages are published to a social media page by default.
    admin_post_urgent	01	enumerated	This is a community admin-only setting. You must be a community admin to set this option, otherwise it will be ignored. Sets whether admins of the yard can post messages as urgent. 0 Yard members cannot post urgent messages. 1 Yard members can post urgent messages.
    member_create_yards	01	enumerated	This is a community-only setting. You must be a community admin and updating the settings for the community yard to set this option, otherwise it will be ignored. Sets whether community members can create yards. 0 Community members are not allowed to create yards. 1 Community members are allowed to create yards.
    community_facebook_enabled	01	enumerated	This is a community-only setting. You must be a community admin and updating the settings for the community yard to set this option, otherwise it will be ignored. Sets whether Facebook notifications can be sent for any yards in the community. Setting this to 0 effectively disables Facebook as a channel for the entire community. Users will still be able to view messages within the ConnectYard Facebook application, but they will not receive any Facebook notifications. 0 Facebook notifications are disabled for the community. 1 Facebook notifications are enabled for the community.
    community_twitter_enabled	01	enumerated	This is a community-only setting. You must be a community admin and updating the settings for the community yard to set this option, otherwise it will be ignored. Sets whether Twitter notifications can be sent for any yards in the community. Setting this to 0 effectively disables Twitter as a channel for the entire community. 0 Twitter notifications are disabled for the community. 1 Twitter notifications are enabled for the community.
    community_whatsapp_enabled	01	enumerated	This is a community-only setting. You must be a community admin and updating the settings for the community yard to set this option, otherwise it will be ignored. Sets whether WhatsApp notifications can be sent for any yards in the community. Setting this to 0 effectively disables WhatsApp as a channel for the entire community. 0 WhatsApp notifications are disabled for the community. 1 WhatsApp notifications are enabled for the community.
    community_text_enabled	01	enumerated	This is a community-only setting. You must be a community admin and updating the settings for the community yard to set this option, otherwise it will be ignored. Sets whether text message notifications can be sent for any yards in the community. Setting this to 0 effectively disables text messaging as a channel for the entire community. 0 Text message notifications are disabled for the community. 1 Text message notifications are enabled for the community.
    community_mail_enabled	01	enumerated	This is a community-only setting. You must be a community admin and updating the settings for the community yard to set this option, otherwise it will be ignored. Sets whether e-mail notifications can be sent for any yards in the community. Setting this to 0 effectively disables e-mail as a channel for the entire community. 0 E-mail notifications are disabled for the community. 1 E-mail notifications are enabled for the community.

  • DELETEUnenroll User/v1/yards/:yard_id/users/:user_id
    Allows users to remove themselves from a yard or Yard/Community Admins to remove users from a yard.
    
    

    Parameter	Value	Type	Description
    yard_id		int	Id for the yard to remove the user.
    user_id		int	Id for the user to be removed.

• User Actions and Notification Settings

  • List Methods
  • Expand Methods

  • GETGet User Info/v1/users/:user_id
    Lookup the user information for a specified user account.
    
    

    Parameter	Value	Type	Description
    user_id		string	Id for the user to be looked up.

  • GETGet Notifications Methods (E-Mail)/v1/users/~/notifications/email
    Allows user to get their email notification settings.
    
    
  • GETGet Notifications Methods (Mobile)/v1/users/~/notifications/mobile
    Allows user to get their mobile notification settings.
    
    
  • GETGet Notifications Methods (Default)/v1/users/~/notifications
    Allows user to get their default notification settings.
    
    
  • GETGet Notifications Methods (Yard)/v1/users/~/notifications/yards/:yard_id
    Allows user to get their yard level notification settings.
    
    

    Parameter	Value	Type	Description
    yard_id		string	Id for the yard to update notification settings.

  • POSTAdd Additional E-mails/v1/users/~/notifications/email/link
    Allows user to add additional e-mail addresses to their account.
    
    

    Parameter	Value	Type	Description
    addl_mails		string	Comma-separated list of e-mail addresses to be associated with this account (ex: test1@test.com,test2@test.com). Each e-mail that is added will be sent a verification e-mail with a link that the user must click before they can start receiving e-mail notifications to that address. Performing this call again with an e-mail that has yet to be verified will resend the verification e-mail.

  • POSTSet Notifications Methods (E-mail)/v1/users/~/notifications/email
    Allows user to set their E-mail notification settings.
    
    

    Parameter	Value	Type	Description
    addl_mails		string	Comma-separated list of e-mail address to be associated with this account (ex: test1@test.com,test2@test.com). Each e-mail that is added will be sent a verification e-mail with a link that the user must click before they can start receiving e-mail notifications to that address. Performing this call again with an e-mail that has yet to be verified will resend the verification e-mail.
    mail_history	01	enumerated	Send message history in e-mail notifications. If not set, will default to disabled. 0 Disabled. 1 Enabled.
    mail_confirmation	01	enumerated	Send confirmation of e-mail delivery. If not set, will default to disabled. 0 Disabled. 1 Enabled.
    mail_copy	01	enumerated	Send copy of posted message as e-mail notification. If not set, will default to disabled. 0 Disabled. 1 Enabled.
    mail_daily_news	01	enumerated	Send daily summary at end of the day. If not set, will default to disabled. 0 Disabled. 1 Enabled.
    mail_send_addl	01	enumerated	Send notifications to additional e-mail(s). If not set, will default to disabled. 0 Disabled. 1 Enabled.

  • POSTAdd Mobile Number and Carrier/v1/users/~/notifications/mobile/link
    Allows user to set their mobile notification settings.
    
    

    Parameter	Value	Type	Description
    cell_number		int	Cell phone number for the user.
    cell_provider		string	Required with cell_number. Cell phone carrier must be included for all numbers. Carrier must be selected from a list provided at CY_Cell_Carriers (http://www.connectyard.com/dist/CY_Cell_Carriers.txt). Providing 'Unknown' as the carrier will perform a lookup on the user's number.

  • POSTLookup Mobile Number/v2/users/~/notifications/mobile/lookup
    Allows user to add their mobile number without their carrier.
    
    

    Parameter	Value	Type	Description
    cell_number		int	Cell phone number for the user.
    cell_country_id		string	Required with cell_number. Cell phone country id must be included for all numbers. Country Id's can be retrieve from the API endpoint (/util/cell_countries).
    cell_verify_skip		string	Set whether you want ConnectYard to send a verification text to the end-user. By default a verification text will be sent and the user will need to verify their mobile device before they can receive notifications. Certain carriers will allow the user to reply to the verification message. In other cases, you can provide the verification via the following API endpoint Verify Mobile. Always ensure that a users cellphone is verified. Skipping should only be done when the user has already opted-in to receive SMS messages from your system, skipped verifications will be internally logged.

  • POSTSet Notifications Methods (Mobile)/v1/users/~/notifications/mobile
    Allows user to set their mobile notification settings.
    
    

    Parameter	Value	Type	Description
    cell_number		int	Cell phone number for the user.
    cell_provider		string	Required with cell_number. Cell phone carrier must be included for all numbers. Carrier must be selected from a list provided at CY_Cell_Carriers (http://www.connectyard.com/dist/CY_Cell_Carriers.txt)
    cell_confirm	01	enumerated	Send confirmation text of received post. 0 Disabled. 1 Enabled.
    cell_chunk	01	enumerated	Send entire message, chunked into multiple texts. 0 Disabled. 1 Enabled.
    cell_attach	01	enumerated	If message contains attachments, send a separate text with the links to the attachments. 0 Disabled. 1 Enabled.

  • POSTAdd WhatsApp Number/v2/users/~/notifications/whatsapp/link
    Allows user to add WhatsApp to their account.
    
    

    Parameter	Value	Type	Description
    whatsapp_number		int	WhatsApp Number for the user.
    whatsapp_country_code		string	Include the international country dial code of the user. Ex: 1 for US or Canada, 52 for Mexico, 11 for UK

  • POSTVerify WhatsApp Number/v2/users/~/notifications/whatsapp/verify
    Have user supply 5-digit verification code that was sent to their WhatsApp account.
    
    

    Parameter	Value	Type	Description
    whatsapp_verification_code		int	5-digit verification code that was sent to user.

  • POSTSet Notifications Methods (Default)/v1/users/~/notifications
    Allows user to set their default notification settings.
    
    

    Parameter	Value	Type	Description
    post_options	01	enumerated	Set how incoming posts will be processed. 0 Notify me for all new posts. 1 Notify me for new posts from admin.
    reply_options	012	enumerated	Set how incoming replies will be processed. 0 Notify me for all replies to a followed message 1 Notify me for only admin replies to a followed message. 2 Notify me for all replies to a followed message
    message_facebook	01	enumerated	Send message notification to Facebook channel. 0 Disabled. 1 Enabled.
    message_twitter	01	enumerated	Send message notification to Twitter channel. 0 Disabled. 1 Enabled.
    message_mail	01	enumerated	Send message notification to e-mail channel. 0 Disabled. 1 Enabled.
    message_cell	01	enumerated	Send message notification to mobile channel. 0 Disabled. 1 Enabled.
    message_whatsapp	01	enumerated	Send message notification to WhatsApp channel. 0 Disabled. 1 Enabled.
    mention_facebook	01	enumerated	Send mention notification to Facebook channel. 0 Disabled. 1 Enabled.
    mention_twitter	01	enumerated	Send mention notification to Twitter channel. 0 Disabled. 1 Enabled.
    mention_mail	01	enumerated	Send mention notification to e-mail channel. 0 Disabled. 1 Enabled.
    mention_cell	01	enumerated	Send mention notification to mobile channel. 0 Disabled. 1 Enabled.
    mention_whatsapp	01	enumerated	Send mention notification to WhatsApp channel. 0 Disabled. 1 Enabled.
    wall_facebook	01	enumerated	Send wall notification to Facebook channel. 0 Disabled. 1 Enabled.
    wall_twitter	01	enumerated	Send wall notification to Twitter channel. 0 Disabled. 1 Enabled.
    wall_mail	01	enumerated	Send wall notification to e-mail channel. 0 Disabled. 1 Enabled.
    wall_cell	01	enumerated	Send wall notification to mobile channel. 0 Disabled. 1 Enabled.
    wall_whatsapp	01	enumerated	Send wall notification to WhatsApp channel. 0 Disabled. 1 Enabled.
    email_frequency	01	enumerated	Receive e-mail notifications via digest instead of individually. 0 Receive E-mails immediately. 1 Receive E-mail Digest every hour. 2 Receive E-mail Digest two hours. 4 Receive E-mail Digest four hours. 6 Receive E-mail Digest six hours.

  • POSTSet Notifications Methods (Yard)/v1/users/~/notifications/yards/:yard_id
    Allows user to set their yard level notification settings.
    
    

    Parameter	Value	Type	Description
    yard_id		string	Id for the yard to update notification settings.
    post_options	01	enumerated	Set how incoming posts will be processed. 0 Notify me for all new posts. 1 Notify me for new posts from admin.
    reply_options	012	enumerated	Set how incoming replies will be processed. 0 Notify me for all replies to a followed message 1 Notify me for only admin replies to a followed message. 2 Notify me for all replies to a followed message
    message_facebook	01	enumerated	Send message notification to Facebook channel. 0 Disabled. 1 Enabled.
    message_twitter	01	enumerated	Send message notification to Twitter channel. 0 Disabled. 1 Enabled.
    message_mail	01	enumerated	Send message notification to e-mail channel. 0 Disabled. 1 Enabled.
    message_cell	01	enumerated	Send message notification to mobile channel. 0 Disabled. 1 Enabled.
    message_whatsapp	01	enumerated	Send message notification to WhatsApp channel. 0 Disabled. 1 Enabled.
    member_facebook	01	enumerated	Send new member notification to Facebook channel. 0 Disabled. 1 Enabled.
    member_twitter	01	enumerated	Send new member notification to Twitter channel. 0 Disabled. 1 Enabled.
    member_mail	01	enumerated	Send new member notification to e-mail channel. 0 Disabled. 1 Enabled.
    member_cell	01	enumerated	Send new member notification to mobile channel. 0 Disabled. 1 Enabled.
    member_whatsapp	01	enumerated	Send new member notification to WhatsApp channel. 0 Disabled. 1 Enabled.
    daily_news	01	enumerated	Include messages from this yard in daily summary. 0 Disabled. 1 Enabled.
    email_frequency	01246	enumerated	Receive e-mail notifications via digest instead of individually. 0 Receive E-mails immediately. 1 Receive E-mail Digest every hour. 2 Receive E-mail Digest two hours. 4 Receive E-mail Digest four hours. 6 Receive E-mail Digest six hours.

  • POSTSet Notifications Methods (Facebook)/v1/users/~/notifications/facebook
    Allows user to pull their current Facebook picture to be used as their ConnectYard profile picture.
    
    

    Parameter	Value	Type	Description
    use_facebook_image	1	enumerated	Sync Facebook Picture to ConnectYard 1 Sync.

  • POSTSet Notifications Methods (Twitter)/v1/users/~/notifications/twitter
    Allows user to pull their current Twitter picture to be used as their ConnectYard profile picture.
    
    

    Parameter	Value	Type	Description
    use_twitter_image	1	enumerated	Sync Twitter Picture to ConnectYard 1 Sync.

  • DELETEDelete Additional E-mail Addresses/v1/users/~/notifications/email
    Allows user to remove additional e-mail addresses from their account.
    
    

    Parameter	Value	Type	Description
    addl_mails		string	Comma-separated list of e-mail address to be removed from this account (ex: test1@test.com,test2@test.com). This will delete both verified and unverified addresses.

  • DELETEDelete Mobile Number/v1/users/~/notifications/mobile/link
    Allows user to remove mobile number and carrier from their account.
    
    
  • DELETEDelete WhatsApp Number/v2/users/~/notifications/whatsapp/link
    Allows user to remove WhatsApp number from their account.
    
    
  • POSTCreate User/v1/users
    This method requires the requesting user to be a Community Admin to create the user within their community.
    
    

    Parameter	Value	Type	Description
    first_name		string	First name of the user being created.
    last_name		string	Last name of the user being created.
    email		string	Valid e-mail address of the user being created.
    send_welcome_mail	01	enumerated	Send Welcome e-mail to new user. 0 Do Not Send Welcome E-mail. 1 Send Welcome E-mail.
    welcome_mail_from		int	Specify the ID of the user to send the welcome e-mail as.
    welcome_mail_template_id		int	Specify the ID of the template to use.

  • POSTUpdate User Info/v1/users/:user_id
    This method may be executed by the community admin or the user who's info is being updated.
    
    

    Parameter	Value	Type	Description
    user_id		string	First name of the user being created.
    name		string	New name that will be assigned to the account.
    email		string	New valid primary e-mail address to be assigned to the account.
    timezone		string	Update users timezone. This is used to configure timestamps within the ConnectYard platform and the e-mail templates. All timestamps sent via the API will still be based on UTC time.

  • POSTChange User Status/v1/users/:user_id/status
    This method will allow you to enable/disable a users account. This method requires the requesting user to be a Community Admin to change a users status within their community.
    
    

    Parameter	Value	Type	Description
    user_id		string	Id of the user looking to change.
    status	10	enumerated	Users account status can be changed between enabled and disabled. 0 Disable User Account. 1 Enable User Account.

  • POSTLink Facebook Account/v1/users/~/notifications/facebook/link
    Allows user to link their Facebook account to ConnectYard. Due to the nature of the linking, this requires user interaction to succesfully link.
    
    

    Parameter	Value	Type	Description
    callback		string	Callback URL that will be used to redirect the user after linking is complete.
    state		string	The state parameter will be passed back in the query string of the callback URL, this is used to protect against Cross-site Request Forgery. You define the state parameter within the session and verfiy on the callback.

  • POSTLink Twitter Account/v1/users/~/notifications/twitter/link
    Allows user to link their Twitter account to ConnectYard. Due to the nature of the linking, this requires user interaction to succesfully link.
    
    

    Parameter	Value	Type	Description
    callback		string	Callback URL that will be used to redirect the user after linking is complete.
    state		string	The state parameter will be passed back in the query string of the callback URL, this is used to protect against Cross-site Request Forgery. You define the state parameter within the session and verfiy on the callback.

  • DELETEDelink Facebook Account/v1/users/~/notifications/facebook/link
    Allows user to delink their Facebook account from ConnectYard.
    
    
  • DELETEDelink Twitter Account/v1/users/~/notifications/twitter/link
    Allows user to delink their Twitter account from ConnectYard.
    
    
  • POSTGenerate SSO URL/v1/users/~/sso/auth
    Generate a url that will automatically authenticate this user into ConnectYard.
    
    

    Parameter	Value	Type	Description
    yard_id		string	Yard Id the user will automatically be redirected, after the SSO is successful.

• Utility Info Actions

  • List Methods
  • Expand Methods

  • GETGet Timezone List/v1/util/timezones
    Retrieve list of available time zones that users can be configured. List will be in an array format, the array key 'America/New_York' is the valid time zone value to use. The array value '(GMT-05:00) Eastern Time (US & Canada)' is simply used to more easily display data to the end users.
    
    
  • GETGet Cell Country List/v2/util/cell_countries
    Retrieve list of currently support countries with the system. This list returns valid Ids to be used in the Mobile Lookup & Get Cell Carriers
    
    
  • GETGet Cell Carriers By Country/v2/util/cell_carriers/:countryAbbr
    Retrieve list of currently support carriers for the selected country. This list returns valid ids to be used in the Add Mobile Number method
    
    

    Parameter	Value	Type	Description
    countryAbbr		string	Use a valid ISO 3166-1 Alpha-2 provided by the Get Cell Country list method.