ACaccredible
Departments

Update a Department

Changed on

Update a Department using this action. It takes a JSON object containing a Department.

Authorization depends on the type of API key you use:

Account-wide keyDepartment-specific key
Any Department in the accountIts own Department only
put/v1/departments/{department_id}

Request

  • Base URL
    https://api.accredible.com
  • URL
    https://api.accredible.com/v1/departments/{department_id}
  • Auth
    API key in header Authorization

Path parameters

department_idstring required

ID of the Department in the form of an integer for the particular Department requested.

Request body

namestring

A name for the Department. This may be displayed publicly on Credentials.

descriptionstring

A description for the Department. This may be displayed publicly.

urlstring

URL for directing users to the website for the given Department. This may be used publicly.

logostring

URL of an image representing the Department logo. Accredible will copy the given image and store the logo within it's own platform. Images should be square, at least 120px wide by 120px tall. PNG format preferred.

page_bannerstring

URL of an image to display as the Department Banner. Accredible will copy the given image and store the logo within it's own platform. The image should be at least 1920px wide by 300px tall. PNG format preferred.

whitelabel_logostring

URL of an image to display in the header and footer of the white-labeled recipient website. The image should be at least 208px wide by 32px tall. PNG format preferred.

linkedin_company_idstring

The LinkedIn company ID for the given Department.

meta_dataobject

You can use this parameter to attach key-value strings to the object. Meta data is useful for storing additional, structured information on an object.

generate_private_credentialboolean

This boolean value will be used as the default of Credential.private when creating a new Credential unless it's overridden by Group.generate_private_credential that is set to true or false.

Response

OK

Changes

  • 98201e8dd1b4Revision changes
    • warning

      deleted the header request parameter Authorization

    • info

      the endpoint scheme security ApiKeyAuth was added to the API