Table of contents

    Overview

    A Role object identifies a Contact‘s or Staff Member’s role. To call the Role endpoint, use one of the URLs from the following table:

    URL GET PUT POST DELETE
    https://api.mypcorp.com/role
    https://api.mypcorp.com/role/{Guid}

    NB: Currently, the MYP API accepts only GET requests for Role endpoint. POST and PUT requests will be available in the future.

    Get

    The following table illustrates which fields can be included when receiving a GET response.

    Role
    Field Name Description
    RoleGuid
    Guid (Identifier)
    The Role id.
    Name
    string
    Name of the Role. E.g. ‘CEO’, ‘Parent’, ‘Administration Assistant’, ‘Family Member’, etc.
    ArchiveDate
    datetime
    Date and time when this Role was archived, if it has been archived.

    Example JSON format:

    {
      "@odata.context": "https://api.mypcorp.com/$metadata#Role",
      "value": [
        {
          "RoleGuid": "d0426984-47d5-4bd8-a5d9-bdc79f21991b",
          "Name": "CEO",
          "ArchiveDate": null
        }
      ]
    }

    Previous article Next article