API
⌘K
My Developer Account

CustomSender

A custom sender that can be used when sending emails.

Example Request

curl https://api.planningcenteronline.com/people/v2

View in API Explorer →

Example Object

{
  "type": "CustomSender",
  "id": "1",
  "attributes": {
    "created_at": "2000-01-01T12:00:00Z",
    "email_address": "string",
    "expired": true,
    "name": "string",
    "updated_at": "2000-01-01T12:00:00Z",
    "verification_requested_at": "2000-01-01T12:00:00Z",
    "verification_status": "string",
    "verified": true,
    "verified_at": "2000-01-01T12:00:00Z"
  },
  "relationships": {
    "custom_sender_shares": {
      "data": {
        "type": "CustomSenderShare",
        "id": "1"
      }
    }
  }
}

Attributes

Name Type Description
created_at date_time
email_address string
expired boolean
id primary_key
name string
updated_at date_time
verification_requested_at date_time
verification_status string
verified boolean
verified_at date_time

Relationships

Name Type Association Type Note
custom_sender_shares CustomSenderShare to_one

Order By

Parameter Value Type Description
order created_at string prefix with a hyphen (-created_at) to reverse the order
order name string prefix with a hyphen (-name) to reverse the order
order updated_at string prefix with a hyphen (-updated_at) to reverse the order
order verification_requested_at string prefix with a hyphen (-verification_requested_at) to reverse the order
order verified_at string prefix with a hyphen (-verified_at) to reverse the order

Pagination

Name Parameter Type Description
per_page per_page integer how many records to return per page (min=1, max=100, default=25)
offset offset integer get results from given offset

Endpoints

Listing

HTTP Method Endpoint
GET /people/v2

Reading

HTTP Method Endpoint
GET /people/v2/{id}

Actions

HTTP Method Endpoint Description
POST https://api.planningcenteronline.com/people/v2 Begins the verification process when a custom sender's email address is created or updated.