PUT /memberships/{membership_gid}

An existing membership can be updated by making a PUT request on the membership. Only the fields provided in the data block will be updated; any unspecified fields will remain unchanged. Memberships on goals, projects, portfolios, custom_types, and custom_fields can be updated.

Returns the full record of the updated membership.

Servers

Path parameters

Name Type Required Description
membership_gid String Yes

Globally unique identifier for the membership.

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/json"

Query parameters

Name Type Required Description
opt_pretty Boolean No

Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging.

Request body fields

Name Type Required Description
data Object No
data.access_level String No

Sets the access level for the member. Goals can have access levels viewer, commenter, editor or admin. Projects can have access levels admin, editor or commenter. Portfolios can have access levels admin, editor or viewer. Custom Fields can have access levels admin, editor or user.

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.