Supported Formats

JSON

GET api.dmarcreport.com/v1/teams/:team_id/user_memberships.json
List of all Users in certain team

Supported Formats

JSON

Errors

Code Description
401 Unauthorized
404 Missing
500 Server crashed for some reason

Examples

{
  "members": [{
    "id": 5,
    "user_id": 2
  }, {
    "id": 8,
    "user_id": 9
  }, {
    "id": 9,
    "user_id": 10
  }, {
    "id": 28,
    "user_id": 22
  }, {
    "id": 29,
    "user_id": 25
  }, {
    "id": 30,
    "user_id": 26
  }]
}

GET api.dmarcreport.com/v1/teams/:team_id/user_memberships/:id.json
Details of certain User Membership

Supported Formats

JSON

Errors

Code Description
401 Unauthorized
404 Missing
500 Server crashed for some reason

Examples

{
  "id": 48,
  "owner": false,
  "read_domain": true,
  "edit_domain": false,
  "add_user": null,
  "remove_user": null,
  "user": {
    "id": 7,
    "email": "q@q.com",
    "created_at": "2019-11-07T12:04:36.817Z",
    "updated_at": "2019-12-26T08:48:47.953Z"
  },
  "team": {
    "id": 17,
    "name": "abc",
    "created_at": "2019-12-23T12:03:46.743Z",
    "updated_at": "2019-12-23T12:03:46.743Z"
  }
}

POST api.dmarcreport.com/v1/teams/:team_id/user_memberships.json
Add a user in your team

Supported Formats

JSON

Errors

Code Description
401 Unauthorized
404 Missing
500 Server crashed for some reason

Params

Param name Description
email
required

User email

Validations:

  • Must be a String

user_membership
required

Validations:

  • Must be a Hash

user_membership[read_domain]
required

Allow user to view current team’s domain

Validations:

  • Must be one of: true, false, true, false.

user_membership[edit_domain]
optional

Allow user to edit current team’s domain

Validations:

  • Must be one of: true, false, true, false.

user_membership[add_user]
optional

Allow User to add new users in current team

Validations:

  • Must be one of: true, false, true, false.

user_membership[remove_user]
optional

Allow user to delete users from current team

Validations:

  • Must be one of: true, false, true, false.


PUT api.dmarcreport.com/v1/teams/:team_id/user_memberships/:id.json
Update certain user in your team

Supported Formats

JSON

Errors

Code Description
401 Unauthorized
404 Missing
500 Server crashed for some reason

Params

Param name Description
user_membership
required

Validations:

  • Must be a Hash

user_membership[read_domain]
required

Allow user to view current team’s domain

Validations:

  • Must be one of: true, false, true, false.

user_membership[edit_domain]
optional

Allow user to edit current team’s domain

Validations:

  • Must be one of: true, false, true, false.

user_membership[add_user]
optional

Allow User to add new users in current team

Validations:

  • Must be one of: true, false, true, false.

user_membership[remove_user]
optional

Allow user to delete users from current team

Validations:

  • Must be one of: true, false, true, false.


DELETE api.dmarcreport.com/v1/teams/:team_id/user_memberships/:id.json
Remove user from your team

Supported Formats

JSON

Errors

Code Description
401 Unauthorized
404 Missing
500 Server crashed for some reason