Almabase(미리 보기)
Almabase는 동문 중심 프로그램을 구축하여 참여, 기부자 참여 및 참여 온라인 커뮤니티를 호스팅하는 세계에서 가장 사랑받는 동창 관리 소프트웨어입니다.
이 커넥터는 다음 제품 및 지역에서 사용할 수 있습니다.
| 서비스 | 클래스 | Regions |
|---|---|---|
| Copilot Studio | Premium | 다음을 제외한 모든 Power Automate 지역 : - 미국 정부(GCC) - 미국 정부(GCC High) - 21Vianet에서 운영하는 중국 클라우드 - 미국 국방부(DoD) |
| 논리 앱 | 스탠다드 | 다음을 제외한 모든 Logic Apps 지역 : - Azure Government 지역 - Azure 중국 지역 - 미국 국방부(DoD) |
| Power Apps | Premium | 다음을 제외한 모든 Power Apps 지역 : - 미국 정부(GCC) - 미국 정부(GCC High) - 21Vianet에서 운영하는 중국 클라우드 - 미국 국방부(DoD) |
| Power Automate | Premium | 다음을 제외한 모든 Power Automate 지역 : - 미국 정부(GCC) - 미국 정부(GCC High) - 21Vianet에서 운영하는 중국 클라우드 - 미국 국방부(DoD) |
| 연락처 | |
|---|---|
| 이름 | Almabase 지원 |
| URL | https://docs.almabase.com |
| 전자 메일 | help@almabase.com |
| 커넥터 메타데이터 | |
|---|---|
| 게시자 | Almabase, Inc. |
| 웹 사이트 | https://almabase.com |
| 개인 정보 보호 정책 | https://www.almabase.com/ecloud-privacy-policy |
| 카테고리 | 판매 및 CRM; 생산력 |
Almabase 는 교육 기관이 교육을 받지 않은 졸업생을 평생 후원자로 바꾸는 동문 중심의 프로그램을 구축하기 위한 소프트웨어 도구 및 전략을 제공합니다.
이 커넥터는 Almabase API 및 Webhook를 기반으로 빌드되며 다음을 포함하여 Almabase 내에서 찾은 엔터티를 관리하는 데 도움이 되는 작업을 제공합니다.
- 레코드(구성 요소)
- 선물
- Events
- Engagement 터치포인트
- 양식
- 자금
- 페이지 제공
- 피어 투 피어 모금 캠페인
- 그 외의 여러 작업...
필수 조건
이 커넥터를 사용하려면
- 활성 Almabase 구독이 있어야 합니다.
- 사이트 관리자 역할이 있어야 합니다.
자격 증명을 가져오는 방법
- Almabase에서 제공하는 관리 포털에 로그인합니다.
- 아래
Settings로 이동합니다API's & Tokens. -
Add Auth Token를 클릭하고 , 를description입력하고 토큰expiry date & time을 설정합니다. - (클립보드에서 복사할 토큰을 클릭)을 적어둡니다
Workflow Access Token. - Power Automate에서
Workflow Access Token새 연결을 만들 때 사용합니다.
커넥터 시작
일반적인 사용 사례
- 선물이 만들어지면 개인 설정된 메시지와 선물 영수증을 보냅니다.
- Slack, Gmail 또는 기타 소셜 미디어에 참여 활동이 기록되면 작업을 사용하여
Create Custom TouchpointAlmabase의 Engagement Studio에 참여 활동을 추가합니다. - 기프트 또는 이벤트 등록 또는 양식 제출에서 새 전자 메일 주소가 발견되면 해당 전자 메일 주소를 Almabase의 레코드 또는 Raiser's Edge의 구성 요소 또는 Salesforce의 연락처에 추가합니다.
- Almabase와 Blackbaud Raiser's Edge 간에 양방향 데이터 동기화를 디자인합니다.
- Almabase와 Salesforce 간의 양방향 데이터 동기화를 디자인합니다.
알려진 문제 및 제한 사항
- 선물 트리거는 Almabase에서 온라인 결제가 이루어지는 경우에만 작동합니다. 수동으로 추가된 선물은 흐름을 트리거하지 않습니다.
연결을 만드는 중
커넥터는 다음 인증 유형을 지원합니다.
| 기본값 | 연결을 만들기 위한 매개 변수입니다. | 모든 지역 | 공유할 수 없음 |
기본값
적용 가능: 모든 지역
연결을 만들기 위한 매개 변수입니다.
공유 가능한 연결이 아닙니다. 전원 앱이 다른 사용자와 공유되면 다른 사용자에게 새 연결을 명시적으로 만들라는 메시지가 표시됩니다.
| 이름 | 유형 | Description | 필수 |
|---|---|---|---|
| 도메인 URL | 문자열 | 예를 들어 Almabase 도메인 URL을 지정합니다. https://your.domain.com | 진실 |
| API 키 | 시큐어스트링 (보안 문자열) | 사용자의 API 키 | 진실 |
제한 한도
| Name | 호출 | 갱신 기간 |
|---|---|---|
| 연결당 API 호출 | 100 | 60초 |
동작
| 기금 만들기 |
새 펀드를 만듭니다. |
| 기금 받기 |
펀드에 대한 정보를 반환합니다. |
| 기부 페이지 가져오기 |
제공 페이지에 대한 정보를 반환합니다. |
| 레코드 가져오기 |
레코드에 대한 정보를 반환합니다. |
| 레코드 나열 |
레코드 목록을 반환합니다. |
| 레코드 만들기 |
새 레코드를 만듭니다. |
| 레코드 업데이트 |
레코드를 업데이트합니다. |
| 레코드의 전자 메일 주소 가져오기 |
레코드의 전자 메일 주소에 대한 정보를 반환합니다. |
| 레코드의 전자 메일 주소 나열 |
레코드의 전자 메일 주소 목록을 반환합니다. |
| 레코드의 전자 메일 주소 만들기 |
레코드에 대한 새 전자 메일 주소를 만듭니다. |
| 레코드의 전자 메일 주소 삭제 |
레코드의 전자 메일 주소를 삭제합니다. |
| 레코드의 전자 메일 주소 업데이트 |
레코드의 전자 메일 주소를 필드를 업데이트합니다. |
| 선물 나열 |
선물 목록을 반환합니다. |
| 선물 만들기 |
새 선물을 만듭니다. |
| 선물 받기 |
선물에 대한 정보를 반환합니다. |
| 선물 업데이트 |
선물 업데이트 |
| 양식 나열 |
양식 목록을 가져옵니다. |
| 양식 제출 |
양식에 대한 새 양식 제출을 만듭니다. |
| 양식 제출 가져오기 |
양식 제출에 대한 정보를 반환합니다. |
| 연락처 사람 업데이트 |
이벤트에서 연락처를 업데이트합니다. |
| 연락처 사용자 나열 |
이벤트에 있는 모든 연락처의 목록을 반환합니다. |
| 연락처 사용자 추가 |
이벤트에 연락처 사용자를 추가합니다. |
| 이벤트 가져오기 |
이벤트에 대한 정보를 반환합니다. |
| 이벤트 나열 |
모든 이벤트의 목록을 반환합니다. |
| 이벤트 만들기 |
새 이벤트를 만듭니다. |
| 이벤트 업데이트 |
이벤트를 업데이트합니다. |
| 자금 나열 |
자금 목록을 반환합니다. |
| 제공 페이지 나열 |
페이지 제공 목록을 반환합니다. |
| 터치포인트 만들기 |
새로운 사용자 지정 터치포인트를 Almabase에 보냅니다. |
| 펀드 업데이트 |
펀드를 업데이트합니다. |
기금 만들기
새 펀드를 만듭니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
외부 데이터베이스 ID
|
external_database_id | string |
외부 데이터베이스에서 펀드에 대한 고유 ID를 할당한 시스템입니다. 예: Raiser Edge NXT의 시스템 레코드 ID, Salesforce의 개체 ID |
|
|
기본 펀드인가요?
|
is_default | boolean |
기부 페이지에 다른 펀드가 정의되지 않은 경우 이 펀드에 대한 모든 분할을 연결하도록 나타냅니다. |
|
|
다른 기금인가요?
|
is_other_fund | boolean |
이 기금의 기부자가 사용자 지정 기금 이름을 지정했음을 나타냅니다. |
|
|
펀드 이름
|
name | True | string |
펀드의 이름 |
반환
선물 분할과 관련된 기금입니다.
기금 받기
펀드에 대한 정보를 반환합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
펀드 ID
|
id | True | integer |
펀드를 고유하게 식별하는 시스템 생성 ID입니다. |
|
Fields
|
fields | array |
응답의 쉼표로 구분된 필드 목록입니다. |
반환
선물 분할과 관련된 기금입니다.
기부 페이지 가져오기
제공 페이지에 대한 정보를 반환합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
페이지 ID 제공
|
id | True | integer |
제공 페이지를 고유하게 식별하는 시스템 생성 ID입니다. |
|
Fields
|
fields | array |
응답의 쉼표로 구분된 필드 목록입니다. |
반환
페이지 제공
레코드 가져오기
레코드에 대한 정보를 반환합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
레코드 ID
|
id | True | integer |
레코드를 고유하게 식별하는 시스템 생성 ID입니다. |
|
Fields
|
fields | array |
응답의 쉼표로 구분된 필드 목록입니다. |
반환
기록
레코드 나열
레코드 목록을 반환합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
이름으로 검색
|
search | string |
이름으로 레코드를 검색합니다. |
|
|
전자 메일 주소로 검색
|
email_addresses__address | string |
전자 메일 주소로 레코드를 검색합니다. |
|
|
외부 데이터베이스 ID로 검색
|
external_database_id | string |
외부 데이터베이스 ID로 레코드를 검색합니다. |
|
|
Fields
|
fields | array |
응답의 쉼표로 구분된 필드 목록입니다. |
|
|
업데이트 날짜 또는 이후에 업데이트됨
|
updated_at__gte | date-time |
날짜 또는 이후에 업데이트되었습니다. |
|
|
만든 이후 또는 그 이후
|
created_at__gte | date-time |
날짜 또는 그 이후에 생성됩니다. |
|
|
페이지 크기
|
page_size | integer |
반환할 레코드 수를 나타냅니다. 기본값은 10입니다. 최대값은 50입니다. |
|
|
페이지 번호
|
page | integer |
페이지 번호(오프셋)를 나타냅니다. 페이지 매김과 함께 사용합니다. |
반환
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
다음 결과 URL
|
nextlink | uri |
결과의 다음 페이지 집합에 대한 URL입니다. 페이지 매김과 함께 사용합니다. |
|
이전 결과 URL
|
previouslink | uri |
이전 결과 집합의 URL입니다. 페이지 매김과 함께 사용합니다. |
|
총 레코드
|
total | integer |
지정된 필터에 대한 총 레코드 |
|
레코드
|
value | array of v1.RecordApi.RecordRead |
지정된 필터에 대해 반환된 레코드의 레코드 목록입니다. |
레코드 만들기
새 레코드를 만듭니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
줄 1
|
line1 | True | string |
주소의 줄 1 |
|
줄 2
|
line2 | string |
주소의 줄 2 |
|
|
이름
|
name | string |
City, State, Country of the Location |
|
|
개인 정보 보호
|
privacy | string |
개인 정보 보호 |
|
|
유형
|
type | True | string |
숫자의 형식 |
|
우편 번호
|
zip_code | string |
주소의 우편 번호 |
|
|
생년월일
|
date_of_birth | string |
생년월일. |
|
|
고
|
deceased | boolean |
고. |
|
|
Address
|
address |
전자 메일 주소 |
||
|
로그인에 사용하시겠습니까?
|
is_login_email | boolean |
사용자가 이 이메일 주소를 사용하여 플랫폼에 로그인할 수 있는지를 나타냅니다. |
|
|
기본인가요?
|
is_primary | boolean |
기본 전자 메일은 시스템에 의해 트리거되는 자동화된 전자 메일을 보내는 데 사용됩니다. 프로필에 대량 전자 메일을 보내는 데도 사용됩니다. 하나의 전자 메일만 기본으로 설정해야 합니다. |
|
|
출처
|
source | string |
원본은 전자 메일이 데이터베이스에 추가되는 방법을 나타냅니다. |
|
|
상태
|
status | string |
전자 메일 주소의 상태 |
|
|
유형
|
type | string |
전자 메일의 유형 |
|
|
외부 데이터베이스 ID
|
external_database_id | string |
외부 데이터베이스에서 레코드에 대해 시스템이 할당한 고유 ID입니다. 예: Raiser Edge NXT의 시스템 레코드 ID, Salesforce의 연락처 ID |
|
|
외부 데이터베이스 조회 ID
|
external_database_lookup_id | string |
외부 데이터베이스의 레코드에 대한 사용자 지정 사용자 정의 조회 ID입니다. 예: 구성 요소 ID |
|
|
이름 (First Name)
|
first_name | True | string |
레코드의 이름입니다. |
|
성 이름
|
last_name | True | string |
레코드의 성입니다. |
|
중간 이름(Middle Name)
|
middle_name | string |
레코드의 중간 이름입니다. |
|
|
Number
|
number | True | string |
Number |
|
개인 정보 보호
|
privacy | string |
개인 정보 보호 |
|
|
유형
|
type | True | string |
숫자의 형식 |
반환
기록
레코드 업데이트
레코드를 업데이트합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
레코드 ID
|
id | True | integer |
레코드를 고유하게 식별하는 시스템 생성 ID입니다. |
|
외부 데이터베이스 ID
|
external_database_id | string |
외부 데이터베이스에서 레코드에 대해 시스템이 할당한 고유 ID입니다. 예: Raiser Edge NXT의 시스템 레코드 ID, Salesforce의 연락처 ID |
|
|
외부 데이터베이스 조회 ID
|
external_database_lookup_id | string |
외부 데이터베이스의 레코드에 대한 사용자 지정 사용자 정의 조회 ID입니다. 예: 구성 요소 ID |
|
|
이름 (First Name)
|
first_name | string |
레코드의 이름입니다. |
|
|
성 이름
|
last_name | string |
레코드의 성입니다. |
반환
기록
레코드의 전자 메일 주소 가져오기
레코드의 전자 메일 주소에 대한 정보를 반환합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
레코드 ID
|
record_id | True | integer |
레코드를 고유하게 식별하는 시스템 생성 ID입니다. |
|
아이디
|
email_id | True | integer |
레코드의 전자 메일 주소를 고유하게 식별하는 시스템 생성 ID입니다. |
반환
이메일 주소
레코드의 전자 메일 주소 나열
레코드의 전자 메일 주소 목록을 반환합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
레코드 ID
|
record_id | True | integer |
레코드를 고유하게 식별하는 시스템 생성 ID입니다. |
|
기본인가요?
|
is_primary | boolean |
기본 전자 메일을 검색합니다. |
|
|
Fields
|
fields | array |
응답의 쉼표로 구분된 필드 목록입니다. |
|
|
페이지 크기
|
page_size | integer |
반환할 레코드 수를 나타냅니다. 기본값은 10입니다. 최대값은 50입니다. |
|
|
페이지 번호
|
page | integer |
페이지 번호(오프셋)를 나타냅니다. 페이지 매김과 함께 사용합니다. |
반환
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
다음 결과 URL
|
nextlink | uri |
결과의 다음 페이지 집합에 대한 URL입니다. 페이지 매김과 함께 사용합니다. |
|
이전 결과 URL
|
previouslink | uri |
이전 결과 집합의 URL입니다. 페이지 매김과 함께 사용합니다. |
|
총 전자 메일 주소
|
total | integer |
지정된 필터의 총 전자 메일 주소 |
|
이메일 주소
|
value | array of v1.RecordApi.EmailAddressRead |
지정된 필터에 대해 반환된 레코드의 전자 메일 주소 목록입니다. 결과는 페이지를 매깁니다. |
레코드의 전자 메일 주소 만들기
레코드에 대한 새 전자 메일 주소를 만듭니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
레코드 ID
|
record_id | True | integer |
레코드를 고유하게 식별하는 시스템 생성 ID입니다. |
|
Address
|
address |
전자 메일 주소 |
||
|
로그인에 사용하시겠습니까?
|
is_login_email | boolean |
사용자가 이 이메일 주소를 사용하여 플랫폼에 로그인할 수 있는지를 나타냅니다. |
|
|
기본인가요?
|
is_primary | boolean |
기본 전자 메일은 시스템에 의해 트리거되는 자동화된 전자 메일을 보내는 데 사용됩니다. 프로필에 대량 전자 메일을 보내는 데도 사용됩니다. 하나의 전자 메일만 기본으로 설정해야 합니다. |
|
|
출처
|
source | string |
원본은 전자 메일이 데이터베이스에 추가되는 방법을 나타냅니다. |
|
|
상태
|
status | string |
전자 메일 주소의 상태 |
|
|
유형
|
type | string |
전자 메일의 유형 |
반환
이메일 주소
레코드의 전자 메일 주소 삭제
레코드의 전자 메일 주소를 삭제합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
레코드 ID
|
record_id | True | integer |
레코드를 고유하게 식별하는 시스템 생성 ID입니다. |
|
아이디
|
email_id | True | integer |
레코드의 전자 메일 주소를 고유하게 식별하는 시스템 생성 ID입니다. |
레코드의 전자 메일 주소 업데이트
레코드의 전자 메일 주소를 필드를 업데이트합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
레코드 ID
|
record_id | True | integer |
레코드를 고유하게 식별하는 시스템 생성 ID입니다. |
|
전자 메일 주소 ID
|
email_id | True | integer |
레코드의 전자 메일 주소를 고유하게 식별하는 시스템 생성 ID입니다. |
|
로그인에 사용하시겠습니까?
|
is_login_email | boolean |
사용자가 이 이메일 주소를 사용하여 플랫폼에 로그인할 수 있는지를 나타냅니다. |
|
|
기본인가요?
|
is_primary | boolean |
기본 전자 메일은 시스템에 의해 트리거되는 자동화된 전자 메일을 보내는 데 사용됩니다. 프로필에 대량 전자 메일을 보내는 데도 사용됩니다. 하나의 전자 메일만 기본으로 설정해야 합니다. |
|
|
상태
|
status | string |
전자 메일 주소의 상태 |
|
|
유형
|
type | string |
전자 메일의 유형 |
반환
이메일 주소
선물 나열
선물 목록을 반환합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
상태
|
status | True | string |
상태에 따라 선물을 필터링합니다. |
|
페이지 제공
|
campaign | integer |
제공 페이지를 고유하게 식별하는 시스템 생성 ID입니다. |
|
|
기프트 그룹 ID로 필터링
|
group_id | uuid |
기프트 그룹 또는 목록을 고유하게 식별하는 시스템 생성 ID입니다. |
|
|
빈 일괄 처리 번호가 있어야 하나요?
|
batch_number__isnull | boolean |
일괄 처리 번호가 있는지 여부에 따라 선물을 필터링합니다. |
|
|
외부 데이터베이스 ID가 비어 있어야 하나요?
|
external_database_id__isnull | boolean |
외부 데이터베이스 ID가 이미 있는지 여부에 따라 선물을 필터링합니다. 참고: 외부 데이터베이스 ID가 있는 선물은 이미 외부 데이터베이스로 푸시됩니다. |
|
|
외부 데이터베이스 ID로 필터링
|
external_database_id | string |
외부 데이터베이스 ID를 기준으로 선물을 필터링합니다. |
|
|
기부자 전자 메일로 필터링
|
donor_email | string |
기부자 이메일 주소를 기준으로 선물 필터링 |
|
|
검색 기준
|
search | string |
이름 또는 전자 메일 주소로 선물을 검색합니다. |
|
|
Fields
|
fields | array |
응답의 쉼표로 구분된 필드 목록입니다. |
|
|
페이지 크기
|
page_size | integer |
반환할 레코드 수를 나타냅니다. 기본값은 10입니다. 최대값은 50입니다. |
|
|
페이지 번호
|
page | integer |
페이지 번호(오프셋)를 나타냅니다. 페이지 매김과 함께 사용합니다. |
|
|
주문 기준
|
ordering | string |
응답에서 선물의 순서를 정의합니다. "-" 접두사는 내림차순을 나타내며 접두사를 없으면 결과가 오름차순으로 반환됩니다. |
반환
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
다음 결과 URL
|
nextlink | uri |
결과의 다음 페이지 집합에 대한 URL입니다. 페이지 매김과 함께 사용합니다. |
|
이전 결과 URL
|
previouslink | uri |
이전 결과 집합의 URL입니다. 페이지 매김과 함께 사용합니다. |
|
총 선물
|
total | integer |
지정된 필터에 대한 총 선물 |
|
선물
|
value | array of v1.GivingApi.GiftRead |
지정된 필터에 대해 반환된 선물 목록입니다. 결과는 페이지를 매깁니다. |
선물 만들기
새 선물을 만듭니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
선물 금액
|
amount | True | string |
2자리 10진수의 선물 금액입니다. |
|
일괄 처리 번호
|
batch_number | string |
선물의 일괄 처리 번호입니다. |
|
|
선물 날짜
|
completed_at | True | date-time |
선물 상태가 완료된 것으로 표시된 날짜입니다. |
|
통화
|
currency | True | integer |
기부자가 선물에 사용하는 통화입니다. |
|
기부자 주소: 줄 1
|
donor_address_line1 | string |
기부자가 선물에 사용하는 주소 줄 1입니다. |
|
|
기부자 주소: 줄 2
|
donor_address_line2 | string |
기부자가 선물에 사용하는 주소 줄 2입니다. |
|
|
이름: City, State, Country
|
name | string |
기증자의 도시. 형식: 도시 이름, 짧은 주 이름, 짧은 국가 이름 |
|
|
기부자 이메일
|
donor_email | True |
기부자가 선물에 사용하는 전자 메일 ID입니다. |
|
|
기부자 이름
|
donor_name | True | string |
기증자의 전체 이름입니다. |
|
기부자 전화 번호
|
donor_phone_number | string |
기부자가 선물에 사용하는 전화 번호입니다. |
|
|
기부자 주소: 우편 번호
|
donor_zip_code | string |
기부자가 선물에 사용하는 주소의 우편 번호입니다. |
|
|
순위표에서 숨겨져 있나요?
|
exclude_from_leaderboard | boolean |
순위표에서 숨겨져 있나요? |
|
|
외부 데이터베이스 ID
|
external_database_id | string |
외부 데이터베이스의 선물에 대해 시스템이 할당한 고유 ID입니다. |
|
|
공물 메시지
|
honor_message | string |
선물에 대한 메시지입니다. |
|
|
공물 접두사
|
honor_prefix | string |
선물 공물의 접두사입니다. 사용 가능한 옵션은 in_honor_of, in_memory_of, in_support_of |
|
|
익명인가요?
|
is_anonymous | boolean |
이 선물에 대한 다른 기부자에게 기증자의 소원을 익명으로 표시합니다. |
|
|
결제 모드
|
mode | True | string |
온라인 또는 오프라인 결제 모드입니다. |
|
비고
|
note | string |
메모 텍스트입니다. |
|
|
기타 펀드 이름
|
other_fund_name | string |
기부자가 is_other_fund 표시된 기금을 선택하면 선물의 특성을 지정하기 위해 사용자 지정 기금 이름을 추가합니다. |
|
|
페이지 제공
|
id | integer |
제공 페이지를 고유하게 식별하는 시스템 생성 ID입니다. |
|
|
아이디
|
id | integer |
레코드를 고유하게 식별하는 시스템 생성 ID입니다. |
|
|
금액
|
amount | True | string |
분할된 선물의 양입니다. |
|
기금
|
id | True | integer |
펀드를 고유하게 식별하는 시스템 생성 ID입니다. |
|
상태
|
status | True | string |
선물의 상태입니다. |
반환
선물
선물 받기
선물에 대한 정보를 반환합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
기프트 ID
|
id | True | integer |
선물을 고유하게 식별하는 시스템 생성 ID입니다. |
|
Fields
|
fields | array |
응답의 쉼표로 구분된 필드 목록입니다. |
반환
선물
선물 업데이트
선물 업데이트
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
기프트 ID
|
id | True | integer |
선물을 고유하게 식별하는 시스템 생성 ID입니다. |
|
일괄 처리 번호
|
batch_number | string |
선물의 일괄 처리 번호입니다. |
|
|
기부자 주소: 줄 1
|
donor_address_line1 | string |
기부자가 선물에 사용하는 주소 줄 1입니다. |
|
|
기부자 주소: 줄 2
|
donor_address_line2 | string |
기부자가 선물에 사용하는 주소 줄 2입니다. |
|
|
이름: City, State, Country
|
name | string |
기증자의 도시. 형식: 도시 이름, 짧은 주 이름, 짧은 국가 이름 |
|
|
기부자 이름
|
donor_name | string |
기증자의 전체 이름입니다. |
|
|
기부자 전화 번호
|
donor_phone_number | string |
기부자가 선물에 사용하는 전화 번호입니다. |
|
|
기부자 주소: 우편 번호
|
donor_zip_code | string |
기부자가 선물에 사용하는 주소의 우편 번호입니다. |
|
|
순위표에서 숨겨져 있나요?
|
exclude_from_leaderboard | boolean |
순위표에서 숨겨져 있나요? |
|
|
외부 데이터베이스 ID
|
external_database_id | string |
외부 데이터베이스의 선물에 대해 시스템이 할당한 고유 ID입니다. |
|
|
공물 메시지
|
honor_message | string |
선물에 대한 메시지입니다. |
|
|
공물 접두사
|
honor_prefix | string |
선물 공물의 접두사입니다. 사용 가능한 옵션은 in_honor_of, in_memory_of, in_support_of |
|
|
익명인가요?
|
is_anonymous | boolean |
이 선물에 대한 다른 기부자에게 기증자의 소원을 익명으로 표시합니다. |
|
|
비고
|
note | string |
메모 텍스트입니다. |
|
|
기타 펀드 이름
|
other_fund_name | string |
기부자가 is_other_fund 표시된 기금을 선택하면 선물의 특성을 지정하기 위해 사용자 지정 기금 이름을 추가합니다. |
|
|
페이지 제공
|
id | integer |
제공 페이지를 고유하게 식별하는 시스템 생성 ID입니다. |
|
|
아이디
|
id | integer |
레코드를 고유하게 식별하는 시스템 생성 ID입니다. |
|
|
금액
|
amount | True | string |
분할된 선물의 양입니다. |
|
기금
|
id | True | integer |
펀드를 고유하게 식별하는 시스템 생성 ID입니다. |
반환
선물
양식 나열
양식 목록을 가져옵니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
Fields
|
fields | array |
응답의 쉼표로 구분된 필드 목록입니다. |
반환
- response
- array of v1.FormApi.FormRead
양식 제출
양식에 대한 새 양식 제출을 만듭니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
Form
|
form_id | True | integer |
양식을 고유하게 식별하는 시스템 생성 ID입니다. |
|
body
|
body | dynamic |
새 양식 제출 만들기 |
반환
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
응답 ID
|
id | integer |
양식 제출을 고유하게 식별하는 시스템 생성 ID입니다. |
양식 제출 가져오기
양식 제출에 대한 정보를 반환합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
Form
|
form_id | True | integer |
양식을 고유하게 식별하는 시스템 생성 ID입니다. |
|
응답 ID
|
entry_id | True | string |
양식 제출을 고유하게 식별하는 시스템 생성 ID입니다. |
반환
연락처 사람 업데이트
이벤트에서 연락처를 업데이트합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
이벤트 ID
|
id | True | integer |
이벤트를 고유하게 식별하는 시스템 생성 ID입니다. |
|
이벤트 연락처 사용자 ID
|
person_id | True | integer |
이벤트에서 연락처를 고유하게 식별하는 시스템 생성 ID입니다. |
|
전자 메일
|
연락처 사용자의 전자 메일 |
|||
|
이름
|
name | string |
연락처의 이름 |
|
|
전화 번호
|
phone_number | string |
대화 상대의 전화 번호 |
반환
이벤트의 담당자에게 문의
연락처 사용자 나열
이벤트에 있는 모든 연락처의 목록을 반환합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
이벤트 ID
|
id | True | integer |
이벤트를 고유하게 식별하는 시스템 생성 ID입니다. |
반환
연락처 사용자 추가
이벤트에 연락처 사용자를 추가합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
이벤트 ID
|
id | True | integer |
이벤트를 고유하게 식별하는 시스템 생성 ID입니다. |
|
전자 메일
|
연락처 사용자의 전자 메일 |
|||
|
이름
|
name | string |
연락처의 이름 |
|
|
전화 번호
|
phone_number | string |
대화 상대의 전화 번호 |
반환
이벤트의 담당자에게 문의
이벤트 가져오기
이벤트에 대한 정보를 반환합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
이벤트 ID
|
id | True | integer |
이벤트를 고유하게 식별하는 시스템 생성 ID입니다. |
|
Fields
|
fields | array |
응답의 쉼표로 구분된 필드 목록입니다. |
반환
Event
이벤트 나열
모든 이벤트의 목록을 반환합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
외부 데이터베이스 ID로 검색
|
external_database_id | string |
외부 데이터베이스 ID로 이벤트를 검색합니다. |
|
|
Fields
|
fields | array |
응답의 쉼표로 구분된 필드 목록입니다. |
반환
- response
- array of v1.EventApi.EventRead
이벤트 만들기
새 이벤트를 만듭니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
Description
|
description | string |
이벤트의 설명 |
|
|
종료 시간
|
end_datetime | string |
이벤트의 종료 시간 |
|
|
외부 데이터베이스 ID
|
external_database_id | string |
외부 데이터베이스에서 레코드에 대해 시스템이 할당한 고유 ID입니다. 예: Raiser Edge NXT의 시스템 레코드 ID, Salesforce의 연락처 ID |
|
|
외부 등록 URL
|
external_registration_url | string |
외부 웹 사이트에서 이벤트의 등록 URL |
|
|
이름
|
name | True | string |
이벤트 이름 |
|
시작 시간
|
start_datetime | string |
이벤트의 시작 시간 |
|
|
Timezone
|
timezone | string |
이벤트의 표준 시간대 |
|
|
이름
|
display_name | string |
City, State, Country of the Venue |
반환
Event
이벤트 업데이트
이벤트를 업데이트합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
이벤트 ID
|
id | True | integer |
이벤트를 고유하게 식별하는 시스템 생성 ID입니다. |
|
Description
|
description | string |
이벤트의 설명 |
|
|
종료 시간
|
end_datetime | string |
이벤트의 종료 시간 |
|
|
외부 데이터베이스 ID
|
external_database_id | string |
외부 데이터베이스에서 레코드에 대해 시스템이 할당한 고유 ID입니다. 예: Raiser Edge NXT의 시스템 레코드 ID, Salesforce의 연락처 ID |
|
|
외부 등록 URL
|
external_registration_url | string |
외부 웹 사이트에서 이벤트의 등록 URL |
|
|
이름
|
name | string |
이벤트 이름 |
|
|
시작 시간
|
start_datetime | string |
이벤트의 시작 시간 |
|
|
Timezone
|
timezone | string |
이벤트의 표준 시간대 |
|
|
이름
|
display_name | string |
City, State, Country of the Venue |
반환
Event
자금 나열
자금 목록을 반환합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
Fields
|
fields | array |
응답의 쉼표로 구분된 필드 목록입니다. |
반환
- response
- array of v1.GivingApi.FundRead
제공 페이지 나열
페이지 제공 목록을 반환합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
Fields
|
fields | array |
응답의 쉼표로 구분된 필드 목록입니다. |
반환
- response
- array of v1.GivingApi.GivingPageRead
터치포인트 만들기
새로운 사용자 지정 터치포인트를 Almabase에 보냅니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
프로그램
|
touchpoint_program | True | integer |
터치포인트 프로그램을 통해 형식을 필터링합니다. |
|
전자 메일
|
활동에 사용되는 전자 메일 ID입니다. |
|||
|
아이디
|
id | integer |
레코드를 고유하게 식별하는 시스템 생성 ID입니다. |
|
|
기록된 위치
|
recorded_at | True | date-time |
활동의 타임스탬프입니다. |
|
유형
|
id | True | integer |
반환
새 터치포인트를 만드는 터치포인트 본문
펀드 업데이트
펀드를 업데이트합니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
펀드 ID
|
id | True | integer |
펀드를 고유하게 식별하는 시스템 생성 ID입니다. |
|
외부 데이터베이스 ID
|
external_database_id | string |
외부 데이터베이스에서 펀드에 대한 고유 ID를 할당한 시스템입니다. 예: Raiser Edge NXT의 시스템 레코드 ID, Salesforce의 개체 ID |
|
|
기본 펀드인가요?
|
is_default | boolean |
기부 페이지에 다른 펀드가 정의되지 않은 경우 이 펀드에 대한 모든 분할을 연결하도록 나타냅니다. |
|
|
다른 기금인가요?
|
is_other_fund | boolean |
이 기금의 기부자가 사용자 지정 기금 이름을 지정했음을 나타냅니다. |
|
|
펀드 이름
|
name | True | string |
펀드의 이름 |
반환
선물 분할과 관련된 기금입니다.
트리거
| Almabase에서 레코드를 만들거나 업데이트하는 경우 |
Almabase에서 새 레코드가 만들어지거나 기존 레코드가 업데이트되면 트리거됩니다. |
| 레코드에서 전자 메일을 만들거나 업데이트하거나 삭제하는 경우 |
레코드에 새 전자 메일이 만들어지거나 기존 전자 메일이 레코드에서 업데이트되거나 삭제될 때 트리거됩니다. |
| 새 선물이 성공하거나 온라인 선물 결제에 실패한 경우 |
기부자가 새 선물을 기부 페이지에 성공적으로 기록하거나 선물에 대한 지불이 실패하면 트리거됩니다. |
| 양식이 제출되거나 기존 양식 제출이 업데이트되는 경우 |
양식이 제출되거나 기존 양식 제출이 업데이트될 때 트리거됩니다. |
Almabase에서 레코드를 만들거나 업데이트하는 경우
Almabase에서 새 레코드가 만들어지거나 기존 레코드가 업데이트되면 트리거됩니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
언제
|
events | True | string |
흐름을 트리거할 이벤트 목록입니다. |
반환
레코드에서 전자 메일을 만들거나 업데이트하거나 삭제하는 경우
레코드에 새 전자 메일이 만들어지거나 기존 전자 메일이 레코드에서 업데이트되거나 삭제될 때 트리거됩니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
언제
|
events | True | string |
흐름을 트리거할 이벤트 목록입니다. |
반환
새 선물이 성공하거나 온라인 선물 결제에 실패한 경우
기부자가 새 선물을 기부 페이지에 성공적으로 기록하거나 선물에 대한 지불이 실패하면 트리거됩니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
언제
|
events | True | string |
흐름을 트리거할 이벤트 목록입니다. |
|
페이지 제공
|
object_id | integer |
제공 페이지를 고유하게 식별하는 시스템 생성 ID입니다. |
반환
양식이 제출되거나 기존 양식 제출이 업데이트되는 경우
양식이 제출되거나 기존 양식 제출이 업데이트될 때 트리거됩니다.
매개 변수
| Name | 키 | 필수 | 형식 | Description |
|---|---|---|---|---|
|
언제
|
events | True | string |
흐름을 트리거할 이벤트 목록입니다. |
|
Form
|
object_id | True | integer |
양식을 고유하게 식별하는 시스템 생성 ID입니다. |
반환
정의
v1. FormApi.FormRead
Form
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
아이디
|
id | integer |
양식을 고유하게 식별하는 시스템 생성 ID입니다. |
|
양식 이름
|
title | string |
양식의 이름입니다. |
v1. GivingApi.GiftWebhookRecordRead
녹음
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
외부 데이터베이스 ID
|
external_database_id | string |
외부 데이터베이스에서 레코드에 대해 시스템이 할당한 고유 ID입니다. 예: Raiser Edge NXT의 시스템 레코드 ID, Salesforce의 연락처 ID |
|
이름 (First Name)
|
first_name | string |
매핑된 레코드의 이름 |
|
아이디
|
id | integer |
레코드를 고유하게 식별하는 시스템 생성 ID입니다. |
|
기부자는 알마베이스에 등록되어 있습니까?
|
is_registered | boolean |
매핑된 레코드 또는 기부자가 Almabase에 등록되었는지 여부를 나타냅니다. |
|
성 이름
|
last_name | string |
매핑된 레코드의 성 |
v1. GivingApi.GiftWebhookResponse
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
금액
|
data.amount | string |
2자리 10진수의 선물 금액입니다. |
|
날짜
|
data.completed_at | date-time |
선물 상태가 완료된 것으로 표시된 날짜입니다. |
|
기부자 이메일
|
data.email |
기부자가 선물에 사용하는 전자 메일 ID입니다. |
|
|
외부 데이터베이스 ID
|
data.external_database_id | string |
외부 데이터베이스의 선물에 대해 시스템이 할당한 고유 ID입니다. |
|
아이디
|
data.id | integer |
선물을 고유하게 식별하는 시스템 생성 ID입니다. |
|
새 전자 메일인가요?
|
data.is_email_new | boolean |
기부자가 제공한 이메일이 Almabase 레코드에 이미 있는지를 나타냅니다. |
|
schema(스키마)
|
data.mapped_profile.schema | v1.GivingApi.GiftWebhookRecordRead |
녹음 |
|
Mode
|
data.mode | string |
선물의 모드입니다. |
|
기부자 이름
|
data.name | string |
기증자의 전체 이름입니다. |
|
아이디
|
data.page.id | integer |
제공 페이지를 고유하게 식별하는 시스템 생성 ID입니다. |
|
페이지 이름 지정
|
data.page.name | string |
연결된 제공 페이지의 이름 |
|
상태
|
data.status | string |
선물의 상태입니다. |
|
에서 트리거된 이벤트
|
time | string |
이벤트 시간입니다. |
|
이벤트 유형
|
type | string |
이벤트 유형입니다. |
v1. GivingApi.LocationRead
기부자가 선물로 사용하는 도시입니다.
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
도시
|
city | string |
기증자의 도시 |
|
도시 짧은 이름
|
city_short_name | string |
구/군/시의 짧은 표현(예: SF) |
|
위도
|
coordinates.latitude | string |
위치의 위도 |
|
경도
|
coordinates.longitude | string |
위치의 경도 |
|
국가
|
country | string |
기증자의 국가 |
|
국가 짧은 이름
|
country_short_name | string |
미국의 짧은 표현(예: 미국) |
|
Google Place Id
|
gpid | string |
Google에서 얻은 장소 ID입니다. |
|
City, State, Country
|
name | string |
기증자의 도시. 형식: 도시 이름, 짧은 주 이름, 짧은 국가 이름 |
|
주
|
state | string |
기증자의 상태 |
|
State Short Name
|
state_short_name | string |
상태의 짧은 표현(예: CA)입니다. |
v1. GivingApi.FormFieldRead
양식 필드
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
가치
|
display_value | string |
응답자가 입력한 형식의 값입니다. 예를 들어 파일 업로드의 이름입니다. |
|
질문/양식 필드 이름
|
label | string |
양식의 질문/양식 필드 이름 |
v1. GivingApi.FundRead
선물 분할과 관련된 기금입니다.
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
외부 데이터베이스 ID
|
external_database_id | string |
외부 데이터베이스에서 펀드에 대한 고유 ID를 할당한 시스템입니다. 예: Raiser Edge NXT의 시스템 레코드 ID, Salesforce의 개체 ID |
|
아이디
|
id | integer |
펀드를 고유하게 식별하는 시스템 생성 ID입니다. |
|
기본 펀드인가요?
|
is_default | boolean |
기부 페이지에 다른 펀드가 정의되지 않은 경우 이 펀드에 대한 모든 분할을 연결하도록 나타냅니다. |
|
다른 기금인가요?
|
is_other_fund | boolean |
이 기금의 기부자가 사용자 지정 기금 이름을 지정했음을 나타냅니다. |
|
이름
|
name | string |
펀드의 이름 |
v1. GivingApi.GiftRead
선물
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
선물 금액
|
amount | string |
2자리 10진수의 선물 금액입니다. |
|
일괄 처리 번호
|
batch_number | string |
선물의 일괄 처리 번호입니다. |
|
선물 날짜
|
completed_at | date-time |
선물 상태가 완료된 것으로 표시된 날짜입니다. |
|
통화
|
currency | integer |
기부자가 선물에 사용하는 통화입니다. |
|
Device
|
device | string |
선물을 만드는 데 사용되는 장치(예: PC, 모바일 또는 태블릿)를 식별합니다. |
|
기부자 주소: 줄 1
|
donor_address_line1 | string |
기부자가 선물에 사용하는 주소 줄 1입니다. |
|
기부자 주소: 줄 2
|
donor_address_line2 | string |
기부자가 선물에 사용하는 주소 줄 2입니다. |
|
기부자 주소: 위치
|
donor_city_place | v1.GivingApi.LocationRead |
기부자가 선물로 사용하는 도시입니다. |
|
기부자 이메일
|
donor_email |
기부자가 선물에 사용하는 전자 메일 ID입니다. |
|
|
기부자 이름
|
donor_name | string |
기증자의 전체 이름입니다. |
|
기부자 전화 번호
|
donor_phone_number | string |
기부자가 선물에 사용하는 전화 번호입니다. |
|
기부자 주소: 우편 번호
|
donor_zip_code | string |
기부자가 선물에 사용하는 주소의 우편 번호입니다. |
|
순위표에서 숨겨져 있나요?
|
exclude_from_leaderboard | boolean |
순위표에서 숨겨져 있나요? |
|
외부 데이터베이스 ID
|
external_database_id | string |
외부 데이터베이스의 선물에 대해 시스템이 할당한 고유 ID입니다. |
|
공물 메시지
|
honor_message | string |
선물에 대한 메시지입니다. |
|
공물 접두사
|
honor_prefix | string |
선물 공물의 접두사입니다. 사용 가능한 옵션은 in_honor_of, in_memory_of, in_support_of |
|
아이디
|
id | integer |
선물을 고유하게 식별하는 시스템 생성 ID입니다. |
|
영향 요인
|
influencer | v1.GivingApi.InfluencerRead |
공개 공유 링크 및 프라이빗 대시보드 링크 |
|
익명인가요?
|
is_anonymous | boolean |
이 선물에 대한 다른 기부자에게 기증자의 소원을 익명으로 표시합니다. |
|
기부자가 결제 게이트웨이 요금을 처리하나요?
|
is_donor_covered_charges | boolean |
기부자가 이 선물을 만들 때 지불 게이트웨이 요금을 충당하기로 결정했는지를 나타냅니다. |
|
전자 메일이 Almabase의 레코드에 추가되어 있나요?
|
is_email_added_to_profile | boolean |
기부자가 제공한 전자 메일이 알마베이스 레코드에 추가되는지 여부(is_email_new 상태와 관계 없이)를 나타냅니다. |
|
새 전자 메일인가요?
|
is_email_new | boolean |
기부자가 제공한 이메일이 Almabase 레코드에 이미 있는지를 나타냅니다. |
|
Almabase의 레코드에 매핑이 무시되었나요?
|
is_profile_mapping_ignored | boolean |
레코드 매핑을 무시해야 하는지를 나타냅니다. |
|
결제 모드
|
mode | string |
온라인 또는 오프라인 결제 모드입니다. |
|
비고
|
note | string |
메모 텍스트입니다. |
|
기타 펀드 이름
|
other_fund_name | string |
기부자가 is_other_fund 표시된 기금을 선택하면 선물의 특성을 지정하기 위해 사용자 지정 기금 이름을 추가합니다. |
|
페이지 제공
|
page | v1.GivingApi.GivingPageAssociatedWithGift |
선물과 관련된 기부 페이지입니다. |
|
Fields
|
post_payment_form_entry.fields | array of v1.GivingApi.FormFieldRead | |
|
응답 ID
|
post_payment_form_entry.id | integer |
양식 제출을 고유하게 식별하는 시스템 생성 ID입니다. |
|
Fields
|
pre_payment_form_entry.fields | array of v1.GivingApi.FormFieldRead | |
|
응답 ID
|
pre_payment_form_entry.id | integer |
양식 제출을 고유하게 식별하는 시스템 생성 ID입니다. |
|
매핑된 레코드
|
profile | v1.GivingApi.RecordRead |
Almabase의 매핑된 레코드 |
|
참조 링크
|
referrer_link | string |
기부자가 방문하는 방법의 출처를 식별하는 웹 사이트 링크입니다. 예를 들어, 기부자는 페이스 북, 구글 등에서 기부 캠페인을 방문했다. |
|
환불 금액
|
refund_amount | string |
기부자에게 환불된 금액입니다. 전체 금액이 환불되면 선물 상태가 완료되지 않고 환불됩니다. |
|
분할
|
splits | array of v1.GivingApi.GiftSplitRead |
선물과 관련된 분할입니다. |
|
상태
|
status | string |
선물의 상태입니다. |
|
온라인 트랜잭션
|
transaction | v1.GivingApi.TransactionRead |
선물과 관련된 온라인 결제 거래입니다. |
|
UTM 캠페인
|
utm_campaign | string |
키워드 분석에 사용됩니다. utm_campaign 특정 제품 홍보 또는 전략적 캠페인을 식별합니다. 예: annual_fund_2020 |
|
UTM 중간
|
utm_medium | string |
utm_medium 전자 메일 또는 클릭당 비용 등의 매체를 식별합니다. 예: cpc |
|
UTM 원본
|
utm_source | string |
utm_source 검색 엔진, 뉴스레터 이름 또는 기타 출처를 식별합니다. 예: Google |
v1. GivingApi.GiftSplitRead
기프트 분할
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
금액
|
amount | string |
분할된 선물의 양입니다. |
|
기금
|
fund | v1.GivingApi.FundRead |
선물 분할과 관련된 기금입니다. |
|
아이디
|
id | integer |
기프트 분할을 고유하게 식별하는 시스템 생성 ID입니다. |
v1. GivingApi.GivingPageAssociatedWithGift
선물과 관련된 기부 페이지입니다.
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
아이디
|
id | integer |
제공 페이지를 고유하게 식별하는 시스템 생성 ID입니다. |
|
이름
|
name | string |
연결된 기부 페이지의 이름입니다. |
v1. GivingApi.GivingPageRead
페이지 제공
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
아이디
|
id | integer |
제공 페이지를 고유하게 식별하는 시스템 생성 ID입니다. |
|
이름
|
name | string |
제공 페이지의 이름 |
v1. GivingApi.InfluencerRead
공개 공유 링크 및 프라이빗 대시보드 링크
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
프라이빗 영향 요인 대시보드 링크
|
dashboard_url | uri |
페이지 방문 횟수 및 기부자의 영향을 받는 선물 수를 모니터링하는 기부자의 개인 대시보드 |
|
공용 공유 링크
|
page_share_url | uri |
기부 페이지 방문 및 선물에 미치는 영향을 추적하기 위한 기부자의 페이지/캠페인 제공의 공개 링크입니다. |
v1. GivingApi.PaymentAccountRead
트랜잭션과 연결된 결제 계정(예: BBMS, Stripe, PayPal 등)입니다.
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
아이디
|
id | integer |
결제 계정을 고유하게 식별하는 시스템 생성 ID입니다. |
|
이름
|
name | string |
결제 계정의 이름입니다. |
|
Gateway
|
type | string |
결제 게이트웨이의 이름입니다. |
v1. GivingApi.RecordRead
Almabase의 매핑된 레코드
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
외부 데이터베이스 ID
|
external_database_id | string |
외부 데이터베이스에서 레코드에 대해 시스템이 할당한 고유 ID입니다. 예: Raiser Edge NXT의 시스템 레코드 ID, Salesforce의 연락처 ID |
|
이름 (First Name)
|
first_name | string |
매핑된 레코드의 이름 |
|
전체 이름
|
formatted_name | string |
매핑된 레코드의 전체 이름 |
|
아이디
|
id | integer |
레코드를 고유하게 식별하는 시스템 생성 ID입니다. |
|
기부자는 알마베이스에 등록되어 있습니까?
|
is_registered | boolean |
매핑된 레코드 또는 기부자가 Almabase에 등록되었는지 여부를 나타냅니다. |
|
성 이름
|
last_name | string |
매핑된 레코드의 성 |
|
그림 URL
|
present_picture | uri |
레코드 그림의 URL |
|
Link
|
profile_url | uri |
Almabase의 레코드 링크 |
v1. GivingApi.TransactionRead
선물과 관련된 온라인 결제 거래입니다.
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
결제 계정
|
account | v1.GivingApi.PaymentAccountRead |
트랜잭션과 연결된 결제 계정(예: BBMS, Stripe, PayPal 등)입니다. |
|
만든 시간
|
created_at | date-time |
이 트랜잭션을 만드는 시간입니다. |
|
실패 이유
|
failure_reason | string |
결제 게이트웨이에서 반환된 트랜잭션 실패 이유입니다. |
|
아이디
|
id | uuid |
트랜잭션을 고유하게 식별하는 시스템 생성 ID입니다. |
|
상태
|
status | integer |
트랜잭션의 상태입니다. - 1(처리되지 않음) - 2(성공) - 3(실패) - 4(보류 중) - 5(오류) 참고: 이러한 상태는 Payment Gateway의 트랜잭션 상태와 연결됩니다. |
|
결제 게이트웨이 참조 ID
|
transaction_id | string |
트랜잭션을 식별하기 위해 결제 게이트웨이에서 생성한 고유 ID입니다. 예: BBMS(Blackbaud Merchant Services) 트랜잭션 ID 또는 스트라이프 요금 ID, PayPal 트랜잭션 ID |
v1. AlmasightsApi.RecordAddOrEdit
알마베이스에 기록.
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
아이디
|
id | integer |
레코드를 고유하게 식별하는 시스템 생성 ID입니다. |
v1. AlmasightsApi.TouchpointCustomObjectAdd
새 터치포인트를 만드는 터치포인트 본문
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
전자 메일
|
활동에 사용되는 전자 메일 ID입니다. |
||
|
녹음
|
mapped_profile | v1.AlmasightsApi.RecordAddOrEdit |
알마베이스에 기록. |
|
기록된 위치
|
recorded_at | date-time |
활동의 타임스탬프입니다. |
|
유형
|
touchpoint_type.id | integer |
v1. RecordApi.LocationRead
주소의 위치
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
도시
|
city | string |
위치의 도시 이름 |
|
국가
|
country | string |
위치의 국가 이름 |
|
위도
|
latitude | double |
위치의 위도 |
|
경도
|
longitude | double |
위치의 경도 |
|
주
|
state | string |
위치의 상태 이름 |
v1. RecordApi.AddressRead
Address
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
줄1
|
line1 | string |
주소의 줄 1 |
|
줄2
|
line2 | string |
주소의 줄 2 |
|
schema(스키마)
|
location.schema | v1.RecordApi.LocationRead |
주소의 위치 |
|
우편 번호
|
zipcode | string |
주소의 우편 번호 |
v1. RecordApi.EmailWebhookRecordRead
녹음
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
외부 데이터베이스 ID
|
external_database_id | string |
외부 데이터베이스에서 레코드에 대해 시스템이 할당한 고유 ID입니다. 예: Raiser Edge NXT의 시스템 레코드 ID, Salesforce의 연락처 ID |
|
이름 (First Name)
|
first_name | string |
매핑된 레코드의 이름 |
|
아이디
|
id | integer |
레코드를 고유하게 식별하는 시스템 생성 ID입니다. |
|
레코드가 Almabase에 등록되어 있나요?
|
is_registered | boolean |
Mapped 레코드가 Almabase에 등록되었는지 여부를 나타냅니다. |
|
성 이름
|
last_name | string |
매핑된 레코드의 성 |
v1. RecordApi.EmailWebhookResponse
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
이메일 주소
|
data.address |
이메일 주소. |
|
|
아이디
|
data.id | integer |
전자 메일을 고유하게 식별하는 시스템 생성 ID입니다. |
|
기본입니다.
|
data.is_primary | boolean |
전자 메일이 기본인지 여부를 나타냅니다. |
|
schema(스키마)
|
data.profile.schema | v1.RecordApi.EmailWebhookRecordRead |
녹음 |
|
전자 메일 유형
|
data.type | string |
전자 메일 주소(기본, 개인, 회사 등)의 유형입니다. |
|
에서 트리거된 이벤트
|
time | string |
이벤트 시간입니다. |
|
이벤트 유형
|
type | string |
이벤트 유형입니다. |
v1. RecordApi.RecordWebhookResponse
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
Affiliations
|
data.affiliations | array of string | |
|
수업 연도
|
data.class_year | string |
레코드의 수업 연도 |
|
이메일 주소
|
data.email |
이메일 주소. |
|
|
외부 데이터베이스 ID
|
data.external_database_id | string |
외부 데이터베이스에서 레코드에 대해 시스템이 할당한 고유 ID입니다. 예: Raiser Edge NXT의 시스템 레코드 ID, Salesforce의 연락처 ID |
|
이름 (First Name)
|
data.first_name | string |
매핑된 레코드의 이름 |
|
schema(스키마)
|
data.home_address.schema | v1.RecordApi.AddressRead |
Address |
|
아이디
|
data.id | integer |
레코드를 고유하게 식별하는 시스템 생성 ID입니다. |
|
성 이름
|
data.last_name | string |
매핑된 레코드의 성 |
|
멤버 자격 만료 날짜
|
data.membership_expiry_date | date-time |
레코드 멤버 자격의 만료 날짜 |
|
멤버 자격 유형 이름
|
data.membership_type_name | string |
레코드의 멤버 자격 유형 이름 |
|
휴대폰 번호
|
data.mobile_number | string |
레코드의 휴대폰 번호 |
|
schema(스키마)
|
data.office_address.schema | v1.RecordApi.AddressRead |
Address |
|
사무실 전화 번호
|
data.office_phone_number | string |
레코드의 사무실 전화 번호 |
|
레지던스 전화 번호
|
data.residence_phone_number | string |
레코드의 레지던스 전화 번호 |
|
에서 트리거된 이벤트
|
time | string |
이벤트 시간입니다. |
|
이벤트 유형
|
type | string |
이벤트 유형입니다. |
v1. RecordApi.EmailAddressRead
이메일 주소
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
Address
|
address |
전자 메일 주소 |
|
|
아이디
|
id | integer |
레코드의 전자 메일 주소를 고유하게 식별하는 시스템 생성 ID입니다. |
|
참여 중입니까?
|
is_engaged | boolean |
대량 전자 메일을 클릭하거나 열거나 사용자가 일대일 전자 메일에 회신하는지 여부를 나타냅니다. |
|
로그인에 사용하시겠습니까?
|
is_login_email | boolean |
사용자가 이 이메일 주소를 사용하여 플랫폼에 로그인할 수 있는지를 나타냅니다. |
|
기본인가요?
|
is_primary | boolean |
기본 전자 메일은 시스템에 의해 트리거되는 자동화된 전자 메일을 보내는 데 사용됩니다. 대량 전자 메일을 레코드로 보내는 데도 사용됩니다. 하나의 전자 메일만 기본으로 설정해야 합니다. |
|
사용자가 확인합니까?
|
is_verified | boolean |
사용자가 전자 메일을 소유하고 있는지 확인했는지 여부를 나타냅니다. |
|
source
|
source | string |
원본은 전자 메일이 데이터베이스에 추가되는 방법을 나타냅니다. |
|
status
|
status | string | |
|
유형
|
type | string |
전자 메일의 유형 |
v1. RecordApi.RecordRead
기록
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
전자 메일 주소
|
email_addresses | array of v1.RecordApi.EmailAddressRead |
프로필의 전자 메일 주소 목록 |
|
외부 데이터베이스 ID
|
external_database_id | string |
외부 데이터베이스에서 레코드에 대해 시스템이 할당한 고유 ID입니다. 예: Raiser Edge NXT의 시스템 레코드 ID, Salesforce의 연락처 ID |
|
이름 (First Name)
|
first_name | string |
레코드의 이름입니다. |
|
전체 이름
|
formatted_name | string |
레코드의 전체 이름입니다. |
|
아이디
|
id | integer |
레코드를 고유하게 식별하는 시스템 생성 ID입니다. |
|
Almabase에 등록되어 있나요?
|
is_registered | boolean |
Almabase에 등록된 레코드 또는 기증자를 나타냅니다. |
|
성 이름
|
last_name | string |
레코드의 성입니다. |
|
그림 URL
|
present_picture | uri |
레코드 그림의 URL |
|
Link
|
record_url | uri |
Almabase의 레코드 링크 |
v1. EventApi.ContactPersonRead
이벤트의 담당자에게 문의
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
전자 메일
|
연락처 사용자의 전자 메일 |
||
|
아이디
|
id | integer |
연락처를 고유하게 식별하는 시스템 생성 ID입니다. |
|
이름
|
name | string |
연락처의 이름 |
|
전화 번호
|
phone_number | string |
대화 상대의 전화 번호 |
v1. EventApi.EventRead
Event
| Name | 경로 | 형식 | Description |
|---|---|---|---|
|
Description
|
description | string |
이벤트의 설명 |
|
종료 시간
|
end_datetime | string |
이벤트의 종료 시간 |
|
외부 데이터베이스 ID
|
external_database_id | string |
외부 데이터베이스에서 레코드에 대해 시스템이 할당한 고유 ID입니다. 예: Raiser Edge NXT의 시스템 레코드 ID, Salesforce의 연락처 ID |
|
외부 등록 URL
|
external_registration_url | string |
외부 웹 사이트에서 이벤트의 등록 URL |
|
아이디
|
id | integer |
이벤트를 고유하게 식별하는 시스템 생성 ID입니다. |
|
이름
|
name | string |
이벤트 이름 |
|
시작 시간
|
start_datetime | string |
이벤트의 시작 시간 |
|
Timezone
|
timezone | string |
이벤트의 표준 시간대 |