v1

latestOpenAPI 3.0.02026-08-062903562.2 MB

Engagement Settings

updateOrganizationEngagementSettings

Update Engagement Settings for Organization

put/engagement-settings/{id}

Path parameters

idstring required

Example:5ceeb33d6e201a648239a387

Primary identifier of Engagement Settings

Request body

email_subdomainstring

Email subdomain

Example request

{
  "email_subdomain": "test12-org-2018102512405088",
  "sms": {
    "enabled": true,
    "phone_numbers": [
      "1-555-555-555"
    ],
    "custom_caller_id": "John Doe"
  },
  "email": {
    "domain_prefix": "test-org-2018102512405088",
    "email_domain": "gofundme-pro-mail.org",
    "enabled": true,
    "throttling": {
      "emails_per_day": 1000,
      "emails_per_month": 10000
    },
    "dns": {
      "is_valid": true,
      "spf": {
        "txt_record": "v=spf1 include:classy.org ~all",
        "valid": true
      },
      "dkim": {
        "txt_record": "k=rsa; p=MIGfMA0GCSqGSIb3DQ...",
        "valid": true
      },
      "tracking": {
        "cname": "email.domain.com",
        "value": "mailgun.org",
        "valid": true
      },
      "incoming": {
        "mx_records": [
          {
            "priority": 10,
            "value": "mxa.mailgun.org"
          }
        ],
        "valid": true
      }
    }
  }
}

Response

Success

idstring

Primary identifier of Engagement Settings

organization_idinteger

ID of the Organization for which Engagement settings belongs

created_atstring date-time

Date/time of initial Engagement Settings creation

updated_atstring date-time

Date/time of Engagement Settings last updated

email_subdomainstring

Email subdomain

Example response

{
  "id": "5ceeb33d6e201a648239a387",
  "organization_id": 82374,
  "created_at": "2019-04-23T10:25:03Z",
  "updated_at": "2019-04-23T10:25:03Z",
  "email_subdomain": "test12-org-2018102512405088",
  "sms": {
    "enabled": true,
    "phone_numbers": [
      "1-555-555-555"
    ],
    "custom_caller_id": "John Doe"
  },
  "email": {
    "domain_prefix": "test-org-2018102512405088",
    "email_domain": "gofundme-pro-mail.org",
    "enabled": true,
    "throttling": {
      "emails_per_day": 1000,
      "emails_per_month": 10000
    },
    "dns": {
      "is_valid": true,
      "spf": {
        "txt_record": "v=spf1 include:classy.org ~all",
        "valid": true
      },
      "dkim": {
        "txt_record": "k=rsa; p=MIGfMA0GCSqGSIb3DQ...",
        "valid": true
      },
      "tracking": {
        "cname": "email.domain.com",
        "value": "mailgun.org",
        "valid": true
      },
      "incoming": {
        "mx_records": [
          {
            "priority": 10,
            "value": "mxa.mailgun.org"
          }
        ],
        "valid": true
      }
    }
  }
}