Supported Formats

JSON

GET api.dmarcreport.com/v2/accounts
List accounts

Supported Formats

JSON

Errors

Code Description
401 Unauthorized
403 Forbidden
404 Not Found
500 Server crashed for some reason

Examples

{
    "note": "When updating or deleting an account, you can use either the 'id' (numeric) or 'slug' in the URL parameter. For example: PUT /v2/accounts/1473 or PUT /v2/accounts/my-team",
    "owned_accounts": [
        {
            "id": 1462,
            "title": "Default",
            "slug": "default-16243a33-8c11-4989-85e1-0b4a09943a05",
            "created_at": "2023-02-22T08:59:26.246Z",
            "updated_at": "2023-02-22T08:59:26.246Z",
            "user_id": 1
        },
        {
            "id": 1473,
            "title": "QA testing update",
            "slug": "qa-testing",
            "created_at": "2023-02-23T13:10:03.072Z",
            "updated_at": "2023-04-07T06:44:16.693Z",
            "user_id": 1
        }

    ],
    "accounts": [
        {
            "id": 1487,
            "title": "testingNew",
            "slug": "testingnew",
            "created_at": "2023-03-01T11:09:29.357Z",
            "updated_at": "2023-03-01T11:09:29.357Z",
            "user_id": 1
        },
        {
            "id": 1488,
            "title": "testing",
            "slug": "testing-ff8ed30a-1b65-4a89-bd22-19d358a1a9bc",
            "created_at": "2023-03-01T11:09:29.455Z",
            "updated_at": "2023-03-01T11:09:29.455Z",
            "user_id": 1
        }
    ]
}

POST api.dmarcreport.com/v2/accounts.json
Add account

Supported Formats

JSON

Errors

Code Description
401 Unauthorized
403 Forbidden
404 Not Found
500 Server crashed for some reason

Params

Param name Description
account
required

Validations:

  • Must be a Hash

account[user_id]
optional

user_id of account

Validations:

  • Must be a String

account[title]
required

title of account

Validations:

  • Must be a String


PUT api.dmarcreport.com/v2/accounts/:id.json
Updates account

The :id parameter can be either the numeric ID or the slug of the account

Supported Formats

JSON

Errors

Code Description
401 Unauthorized
403 Forbidden
404 Not Found
500 Server crashed for some reason

Params

Param name Description
id
required

Account ID (numeric, e.g., “1473”) or slug (e.g., “my-team”)

Validations:

  • Must be a String

account
required

Validations:

  • Must be a Hash

account[title]
required

Title of team

Validations:

  • Must be a String


DELETE api.dmarcreport.com/v2/accounts/:id.json
Delete account

The :id parameter can be either the numeric ID or the slug of the account

Supported Formats

JSON

Errors

Code Description
401 Unauthorized
403 Forbidden
404 Not Found
500 Server crashed for some reason

Params

Param name Description
id
required

Account ID (numeric, e.g., “1473”) or slug (e.g., “my-team”)

Validations:

  • Must be a String