Team members

Create or update team member

Create or update a team member.

If the team member with the specified email address already exists, the existing team member will be updated.

Updating the custom_attributes field will overwrite any existing custom attributes.

Required scopes: write team members

post/api/v1/team-members

Request

  • Base URL: https://api.simplesat.io
  • URL: https://api.simplesat.io/api/v1/team-members
  • Auth: API key in header X-Simplesat-Token

Request body

external_idstring
namestring
emailstring
custom_attributesobject

Example request

{
  "external_id": "1",
  "name": "Tester McTestFace",
  "email": "tester@simplesat.io",
  "custom_attributes": {
    "Department": "Support",
    "Level": "Senior"
  }
}

Response

Successful response

idinteger
external_idstring
namestring
emailstring
custom_attributesobject

Example response

{
  "id": 1,
  "external_id": "1",
  "name": "Tester McTestFace",
  "email": "tester@simplesat.io",
  "custom_attributes": {
    "Department": "Support",
    "Level": "Senior"
  },
  "groups": [
    {
      "token": "iLA0X65ayqAgnnqnKSFuAwlgtiFGbt3gcN-L73SHNP0",
      "name": "Outsource BPO"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.