The SMS Center object

Attributes

id string

Unique identifier for the object.

created_at string

ISO 8601 timestamp of when the object was created.

updated_at string

ISO 8601 timestamp of when the object was last updated.

send_to string
customer string
supplier string
sales_partner string
department string
branch string
receiver_list string
message string required
total_characters integer
total_messages integer
The SMS Center object 
{
  "id": "s-m-s-center_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "send_to": "send_to_example",
  "customer": "customer_example",
  "supplier": "supplier_example",
  "sales_partner": "sales_partner_example",
  "department": "department_example",
  "branch": "branch_example",
  "receiver_list": "receiver_list_example",
  "message": "message_example",
  "total_characters": 0,
  "total_messages": 0
}
GET /api/crm/s-m-s-center/{id}

Retrieve a sms center

Retrieves the details of an existing sms center. Supply the unique sms center ID that was returned from a previous request.

Path parameters

id string required

The identifier of the sms center to retrieve.

Returns

Returns the sms center object if a valid identifier was provided.

GET /api/crm/s-m-s-center/{id} 
curl https://api.overplane.dev/api/crm/s-m-s-center/s-m-s-center_abc123 \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "id": "s-m-s-center_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "send_to": "send_to_example",
  "customer": "customer_example",
  "supplier": "supplier_example",
  "sales_partner": "sales_partner_example",
  "department": "department_example",
  "branch": "branch_example",
  "receiver_list": "receiver_list_example",
  "message": "message_example",
  "total_characters": 0,
  "total_messages": 0
}
GET /api/crm/s-m-s-center

List all sms centers

Returns a list of sms centers. The results are sorted by creation date, with the most recently created appearing first.

Query parameters

limit integer

Maximum number of objects to return. Default: 20.

offset integer

Number of objects to skip for pagination. Default: 0.

Returns

A paginated list of sms center objects.

GET /api/crm/s-m-s-center 
curl https://api.overplane.dev/api/crm/s-m-s-center \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "data": [
    {
      "id": "s-m-s-center_abc123",
      "created_at": "2024-01-15T09: 30: 00Z",
      "updated_at": "2024-01-15T09: 30: 00Z",
      "send_to": "send_to_example",
      "customer": "customer_example",
      "supplier": "supplier_example",
      "sales_partner": "sales_partner_example",
      "department": "department_example",
      "branch": "branch_example",
      "receiver_list": "receiver_list_example",
      "message": "message_example",
      "total_characters": 0,
      "total_messages": 0
    }
  ],
  "has_more": false,
  "total": 1
}
POST /api/crm/s-m-s-center

Create a sms center

Creates a new sms center object.

Body parameters

send_to string
customer string
supplier string
sales_partner string
department string
branch string
receiver_list string
message string required
total_characters integer
total_messages integer

Returns

Returns the newly created sms center object if the call succeeded.

POST /api/crm/s-m-s-center 
curl https://api.overplane.dev/api/crm/s-m-s-center \
  -H "Authorization: Bearer sk_test_..." \
  -X POST \
  -H "Content-Type: application/json" \
  -d '{"message":"message_example"}'
Response 
{
  "id": "s-m-s-center_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "send_to": "send_to_example",
  "customer": "customer_example",
  "supplier": "supplier_example",
  "sales_partner": "sales_partner_example",
  "department": "department_example",
  "branch": "branch_example",
  "receiver_list": "receiver_list_example",
  "message": "message_example",
  "total_characters": 0,
  "total_messages": 0
}
PATCH /api/crm/s-m-s-center/{id}

Update a sms center

Updates the specified sms center by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

Path parameters

id string required

The identifier of the sms center to update.

Body parameters

send_to string
customer string
supplier string
sales_partner string
department string
branch string
receiver_list string
message string
total_characters integer
total_messages integer

Returns

Returns the updated sms center object.

PATCH /api/crm/s-m-s-center/{id} 
curl https://api.overplane.dev/api/crm/s-m-s-center/s-m-s-center_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X PATCH \
  -H "Content-Type: application/json" \
  -d '{"send_to":"send_to_example","customer":"customer_example"}'
Response 
{
  "id": "s-m-s-center_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "send_to": "send_to_example",
  "customer": "customer_example",
  "supplier": "supplier_example",
  "sales_partner": "sales_partner_example",
  "department": "department_example",
  "branch": "branch_example",
  "receiver_list": "receiver_list_example",
  "message": "message_example",
  "total_characters": 0,
  "total_messages": 0
}
DELETE /api/crm/s-m-s-center/{id}

Delete a sms center

Permanently deletes a sms center. This cannot be undone.

Path parameters

id string required

The identifier of the sms center to delete.

Returns

Returns a confirmation that the sms center has been deleted.

DELETE /api/crm/s-m-s-center/{id} 
curl https://api.overplane.dev/api/crm/s-m-s-center/s-m-s-center_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X DELETE
Response 
{
  "id": "s-m-s-center_abc123",
  "deleted": true
}