Organizations

Organizations Documentation

Organization [POST]

Organization [POST]

Request

Endpoint

POST /api/v2/admin/organizations
Content-Type: application/vnd.api+json

Body

{
  "data": {
    "type": "organizations",
    "attributes": {
      "country": "United States",
      "name": "Cru (Offline)",
      "org_help_url": "https://cru.org"
    }
  }
}

Parameters

Attributes

country

Type string

Description The default country that account lists associated with this organization will be set to

Required No

created_at

Type date

Description The timestamp of when this resource was created

Required No

name

Type string

Description The name of the new organization

Required No

org_help_url

Type string

Description The url of the organization

Required No

updated_at

Type date

Description The timestamp of when this resource was last updated

Required No

updated_in_db_at

Type date

Description This is to be used as a reference for the last time the resource was updated in the remote database - specifically for when data is updated while the client is offline.

Required No

Response

Headers

Content-Type: application/vnd.api+json; charset=utf-8
201 Created

Body

{
  "data": {
    "id": "be6711e1-6401-45c8-b15a-0b32f22e37cd",
    "type": "organizations",
    "attributes": {
      "abbreviation": null,
      "code": null,
      "country": null,
      "created_at": "2022-01-12T17:19:02Z",
      "default_currency_code": "USD",
      "gift_aid_percentage": null,
      "logo": null,
      "name": "Cru (Offline)",
      "oauth": false,
      "updated_at": "2022-01-12T17:19:02Z",
      "updated_in_db_at": "2022-01-12T17:19:02Z"
    }
  }
}

Fields

Attributes

abbreviation

Type string

Description Short name

code

Type string

Description Reference code

country

Type string

Description Country organization is located in primarily

created_at

Type date

Description The timestamp of when this resource was created

default_currency_code

Type string

Description Three letter currency code the organization primarily trades in

gift_aid_percentage

Type number

Description Percentage of gift aid on each received donation

logo

Type string

Description URL of the organization's logo

name

Type string

Description Name of the organization

oauth

Type boolean

Description If the organization is using OAuth to connect its users to MPDX

updated_at

Type date

Description The timestamp of when this resource was last updated

updated_in_db_at

Type date

Description This is to be used as a reference for the last time the resource was updated in the remote database - specifically for when data is updated while the client is offline.